aboutsummaryrefslogtreecommitdiff
path: root/doc/developer-notes.md
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2017-06-26 13:37:42 +0200
committerWladimir J. van der Laan <laanwj@gmail.com>2017-06-26 13:40:26 +0200
commitf3f1e2e7d38005fa3edecb01469a18a6f7500ea6 (patch)
treedcb6ea5f65307e2d5c6dee21b739a52870a660da /doc/developer-notes.md
parentd609fd85ca41c003233d74fbd6c680970ad4a48b (diff)
parent5a9b508279b3a221d36149aa2e811a9702b28e60 (diff)
Merge #9544: [trivial] Add end of namespace comments. Improve consistency.
5a9b508 [trivial] Add end of namespace comments (practicalswift) Tree-SHA512: 92b0fcae4d1d3f4da9e97569ae84ef2d6e09625a5815cd0e5f0eb6dd2ecba9852fa85c184c5ae9de5117050330ce995e9867b451fa8cd5512169025990541a2b
Diffstat (limited to 'doc/developer-notes.md')
-rw-r--r--doc/developer-notes.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index a7fb4b4da1..81bdcc9fdb 100644
--- a/doc/developer-notes.md
+++ b/doc/developer-notes.md
@@ -68,7 +68,7 @@ public:
return true;
}
}
-}
+} // namespace foo
```
Doxygen comments
@@ -438,6 +438,21 @@ Source code organization
- *Rationale*: Avoids symbol conflicts
+- Terminate namespaces with a comment (`// namespace mynamespace`). The comment
+ should be placed on the same line as the brace closing the namespace, e.g.
+
+```c++
+namespace mynamespace {
+ ...
+} // namespace mynamespace
+
+namespace {
+ ...
+} // namespace
+```
+
+ - *Rationale*: Avoids confusion about the namespace context
+
GUI
-----