# HG changeset patch # User alpar # Date 1083577097 0 # Node ID dcfb684468433f5c53898d436cb605ab8cd02d5c # Parent fde7814bfd2d2902367e63983316aed7ca1cc274 A "related pages" about Hugo Coding Style. To be improved. diff -r fde7814bfd2d -r dcfb68446843 doc/Doxyfile --- a/doc/Doxyfile Mon May 03 09:18:01 2004 +0000 +++ b/doc/Doxyfile Mon May 03 09:38:17 2004 +0000 @@ -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 \ diff -r fde7814bfd2d -r dcfb68446843 doc/coding_style.dox --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/coding_style.dox Mon May 03 09:38:17 2004 +0000 @@ -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 + + +*/