1.1 --- a/doc/coding_style.dox	Mon Nov 01 19:00:19 2004 +0000
     1.2 +++ b/doc/coding_style.dox	Tue Nov 02 06:28:38 2004 +0000
     1.3 @@ -11,9 +11,35 @@
     1.4  it. Please comply with these conventions if you want to contribute
     1.5  developing LEMON library.
     1.6  
     1.7 +\warning In some cases we diverge from these rules.
     1.8 +This primary done because STL uses different naming convention and
     1.9 +in certain cases
    1.10 +it is beneficial to provide STL compatible interface.
    1.11 +
    1.12 +\subsection cs-files File Names
    1.13 +
    1.14 +The header file names should look like the following.
    1.15 +
    1.16 +\code
    1.17 +header_file.h
    1.18 +\endcode
    1.19 +
    1.20 +Note that all standard Lemon headers are located in the \c lemon subdirectory,
    1.21 +so you should include them from C++ source like this:
    1.22 +
    1.23 +\code
    1.24 +#include <lemon/header_file.h>
    1.25 +\endcode
    1.26 +
    1.27 +The source code files use the same style and they have '.cc' extension.
    1.28 +
    1.29 +\code
    1.30 +source_code.cc
    1.31 +\endcode
    1.32 +
    1.33  \subsection cs-class Classes and other types
    1.34  
    1.35 -The name of a class or any type should look like the following:
    1.36 +The name of a class or any type should look like the following.
    1.37  
    1.38  \code
    1.39  AllWordsCapitalizedWithoutUnderscores 
    1.40 @@ -21,7 +47,7 @@
    1.41  
    1.42  \subsection cs-func Methods and other functions
    1.43  
    1.44 -The name of a function should look like the following:
    1.45 +The name of a function should look like the following.
    1.46  
    1.47  \code
    1.48  firstWordLowerCaseRestCapitalizedWithoutUnderscores 
    1.49 @@ -29,7 +55,7 @@
    1.50  
    1.51  \subsection cs-funcs Constants, Macros
    1.52  
    1.53 -The names of constants and macros should look like the following:
    1.54 +The names of constants and macros should look like the following.
    1.55  
    1.56  \code
    1.57  ALL_UPPER_CASE_WITH_UNDERSCORES 
    1.58 @@ -37,7 +63,7 @@
    1.59  
    1.60  \subsection cs-loc-var Class and instance member variables, auto variables 
    1.61  
    1.62 -The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
    1.63 +The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following.
    1.64  
    1.65  \code
    1.66  all_lower_case_with_underscores 
    1.67 @@ -45,15 +71,10 @@
    1.68  
    1.69  \subsection cs-excep Exceptions
    1.70  
    1.71 -When writing exceptions please comply the following naming conventions:
    1.72 +When writing exceptions please comply the following naming conventions.
    1.73  
    1.74  \code
    1.75  ClassNameEndsWithException
    1.76  \endcode
    1.77  
    1.78 -\warning In some cases we diverge from these rules.
    1.79 -This primary done because STL uses different naming convention and
    1.80 -in certain cases
    1.81 -it is beneficial to provide STL compatible interface.
    1.82 -
    1.83  */