From: g0dil <g0dil@270642c3-0616-0410-b53a-bc976706d245>
Date: Tue, 18 Dec 2007 12:56:44 +0000 (+0000)
Subject: Add documentation on private data member naming convention
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=74270969b7d3562a3ee3a0a32d3cc4ee476760f0;p=senf.git

Add documentation on private data member naming convention

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@578 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/Mainpage.dox b/Mainpage.dox
index 84a04ee..6488966 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -428,6 +428,13 @@
         Together with splitting inlines and non-inlines into separate files, this allows to
         automatically include the inline definitions at the right places. See above.
 
+    Private data members are named with a trailing underscore character.
+
+    \par Rationale:
+        This helps distinguishing local variables from parameter names. The trailing underscore
+        does not interfere with other naming conventions and is allowed by the standard (underscore
+        at the beginning of the name are problematic since some classes of names beginning with an
+        underscore are reserved for the standard library implementation)
  */