A "related pages" about Hugo Coding Style.
authoralpar
Mon, 03 May 2004 09:38:17 +0000
changeset 507dcfb68446843
parent 506 fde7814bfd2d
child 508 95f8f7171bae
A "related pages" about Hugo Coding Style.
To be improved.
doc/Doxyfile
doc/coding_style.dox
     1.1 --- a/doc/Doxyfile	Mon May 03 09:18:01 2004 +0000
     1.2 +++ b/doc/Doxyfile	Mon May 03 09:38:17 2004 +0000
     1.3 @@ -392,7 +392,8 @@
     1.4  # with spaces.
     1.5  
     1.6  INPUT                  = mainpage.dox \
     1.7 -                         maps.dox groups.dox \
     1.8 +                         maps.dox coding_style.dox \
     1.9 +                         groups.dox \
    1.10                           ../src/include \
    1.11                           ../src/include/skeletons \
    1.12                           ../src/work/alpar/list_graph.h \
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/doc/coding_style.dox	Mon May 03 09:38:17 2004 +0000
     2.3 @@ -0,0 +1,46 @@
     2.4 +/*!
     2.5 +
     2.6 +\page coding_style Hugo's Coding Style 
     2.7 +
     2.8 +\todo More detailed description, an introductory paragraph, etc.
     2.9 + 
    2.10 +\section Naming Convenions
    2.11 +
    2.12 +\subsection Classes
    2.13 +
    2.14 +\code
    2.15 +AllWordsCapitalizedWithoutUnderscores 
    2.16 +\endcode
    2.17 +
    2.18 +\subsection Methods
    2.19 +
    2.20 +\code
    2.21 +firstWordLowerCaseRestCapitalizedWithoutUnderscores 
    2.22 +\endcode
    2.23 +
    2.24 +\subsection Constants
    2.25 +
    2.26 +\code
    2.27 +ALL_UPPER_CASE_WITH_UNDERSCORES 
    2.28 +\endcode
    2.29 +
    2.30 +\subsection %Class and instance member variables
    2.31 +
    2.32 +\code
    2.33 +all_lower_case_with_underscores 
    2.34 +\endcode
    2.35 +
    2.36 +\subsection Auto variables (=variables used locally in methods)
    2.37 +
    2.38 +\code
    2.39 +all_lower_case_with_underscores 
    2.40 +\endcode
    2.41 +
    2.42 +\subsection Exceptions
    2.43 +
    2.44 +\code
    2.45 +ClassNameEndsWithException
    2.46 +\endcode
    2.47 +
    2.48 +
    2.49 +*/