Add some info about namespaces

Change-Id: I6e3c2900b3f3c96e4b9f6657f9371fd728e5bd91
Reviewed-on: http://codereview.qt.nokia.com/3722
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>

diff --git a/doc/api/coding-style.qdoc b/doc/api/coding-style.qdoc
index ea617d3..1cbe024 100644 (file)
--- a/doc/api/coding-style.qdoc
+++ b/doc/api/coding-style.qdoc
@@ -500,6 +500,20 @@
 
     \section1 Patterns and Practices
 
+    \section2 Namespacing
+
+    Read \l {http://developer.qt.nokia.com/wiki/Qt_In_Namespace}{Qt In Namespace}
+    and keep in mind that all of Qt Creator is \e{namespace aware} code.
+
+    The namespacing policy within Qt Creator is as follows:
+    \list
+        \o Classes/Symbols of a library or plugin that are exported for use of
+           other libraries or plugins are in a namespace specific to that
+           library/plugin, e.g. \c{MyPlugin}.
+        \o Classes/Symbols of a library or plugin that are not exported are in
+           an additional \c{Internal} namespace, e.g. \c{MyPlugin::Internal}.
+    \endlist
+
     \section2 Passing File Names
 
     Qt Creator API expects file names in portable format, that is, with slashes (/)
@@ -804,11 +818,6 @@
     Suddenly, QList symbols are exported from two libraries which results in a
     clash.
 
-    \section2 Namespacing
-
-    Read \l {http://developer.qt.nokia.com/wiki/Qt_In_Namespace}{Qt In Namespace}
-    and keep in mind that all of Qt Creator is \e{namespace aware} code.
-
     \section2 Conventions for Public Header Files
 
     Our public header files have to survive the strict settings of