From cd0673f78788e3eada78fca68762719260f04cfe Mon Sep 17 00:00:00 2001
From: hjk <qtc-committer@nokia.com>
Date: Fri, 11 Nov 2011 16:24:30 +0100
Subject: [PATCH] codingstyle: add namespace rules
Change-Id: Ib6b3e37376084e2305143e42c85d13ce66ec9f2b
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
---
doc/api/coding-style.qdoc | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/doc/api/coding-style.qdoc b/doc/api/coding-style.qdoc
index 6e9745ea166..8836532846e 100644
--- a/doc/api/coding-style.qdoc
+++ b/doc/api/coding-style.qdoc
@@ -492,6 +492,29 @@
important when initialization is done at the same time.
\endlist
+ \section2 Namespaces
+
+ \list
+ \o Put the left curly brace on the same line as the \namespace keyword.
+ \o Do not indent declarations or definitions inside.
+ \o Optional, but recommended if the namespaces spans more than a few lines:
+ Add a comment after the right curly brace repeating the namespace.
+
+ \code
+ namespace MyPlugin {
+
+ void someFunction() { ... }
+
+ } // namespace MyPlugin
+ \endcode
+
+ \o As an exception, if there is only a single class declaration inside
+ the namespace, all can go on a single line:
+ \code
+ namespace MyPlugin { class MyClass; }
+ \endcode
+ \endlist
+
\section1 Patterns and Practices
\section2 Namespacing
--
GitLab