diff -r 5b1ffef43d4c -r 0a066f80e05f doc/coding_style.dox --- a/doc/coding_style.dox Mon Nov 01 19:00:19 2004 +0000 +++ b/doc/coding_style.dox Tue Nov 02 06:28:38 2004 +0000 @@ -11,9 +11,35 @@ it. Please comply with these conventions if you want to contribute developing LEMON library. +\warning In some cases we diverge from these rules. +This primary done because STL uses different naming convention and +in certain cases +it is beneficial to provide STL compatible interface. + +\subsection cs-files File Names + +The header file names should look like the following. + +\code +header_file.h +\endcode + +Note that all standard Lemon headers are located in the \c lemon subdirectory, +so you should include them from C++ source like this: + +\code +#include +\endcode + +The source code files use the same style and they have '.cc' extension. + +\code +source_code.cc +\endcode + \subsection cs-class Classes and other types -The name of a class or any type should look like the following: +The name of a class or any type should look like the following. \code AllWordsCapitalizedWithoutUnderscores @@ -21,7 +47,7 @@ \subsection cs-func Methods and other functions -The name of a function should look like the following: +The name of a function should look like the following. \code firstWordLowerCaseRestCapitalizedWithoutUnderscores @@ -29,7 +55,7 @@ \subsection cs-funcs Constants, Macros -The names of constants and macros should look like the following: +The names of constants and macros should look like the following. \code ALL_UPPER_CASE_WITH_UNDERSCORES @@ -37,7 +63,7 @@ \subsection cs-loc-var Class and instance member variables, auto variables -The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following: +The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following. \code all_lower_case_with_underscores @@ -45,15 +71,10 @@ \subsection cs-excep Exceptions -When writing exceptions please comply the following naming conventions: +When writing exceptions please comply the following naming conventions. \code ClassNameEndsWithException \endcode -\warning In some cases we diverge from these rules. -This primary done because STL uses different naming convention and -in certain cases -it is beneficial to provide STL compatible interface. - */