[Lemon-commits] [lemon_svn] alpar: r667 - hugo/trunk/doc

[Lemon SVN]

Author: alpar
Date: Mon May  3 11:38:17 2004
New Revision: 667

Added:
   hugo/trunk/doc/coding_style.dox
Modified:
   hugo/trunk/doc/Doxyfile

Log:
A "related pages" about Hugo Coding Style.
To be improved.

Modified: hugo/trunk/doc/Doxyfile
==============================================================================
--- hugo/trunk/doc/Doxyfile	(original)
+++ hugo/trunk/doc/Doxyfile	Mon May  3 11:38:17 2004
@@ -392,7 +392,8 @@
 # with spaces.
 
 INPUT                  = mainpage.dox \
-                         maps.dox groups.dox \
+                         maps.dox coding_style.dox \
+                         groups.dox \
                          ../src/include \
                          ../src/include/skeletons \
                          ../src/work/alpar/list_graph.h \

Added: hugo/trunk/doc/coding_style.dox
==============================================================================
--- (empty file)
+++ hugo/trunk/doc/coding_style.dox	Mon May  3 11:38:17 2004
@@ -0,0 +1,46 @@
+/*!
+
+\page coding_style Hugo's Coding Style 
+
+\todo More detailed description, an introductory paragraph, etc.
+ 
+\section Naming Convenions
+
+\subsection Classes
+
+\code
+AllWordsCapitalizedWithoutUnderscores 
+\endcode
+
+\subsection Methods
+
+\code
+firstWordLowerCaseRestCapitalizedWithoutUnderscores 
+\endcode
+
+\subsection Constants
+
+\code
+ALL_UPPER_CASE_WITH_UNDERSCORES 
+\endcode
+
+\subsection %Class and instance member variables
+
+\code
+all_lower_case_with_underscores 
+\endcode
+
+\subsection Auto variables (=variables used locally in methods)
+
+\code
+all_lower_case_with_underscores 
+\endcode
+
+\subsection Exceptions
+
+\code
+ClassNameEndsWithException
+\endcode
+
+
+*/