doc/coding_style.dox
changeset 2175 0975cad06c2b
parent 1788 614ce2dd3cba
child 2391 14a343be7a5a
equal deleted inserted replaced
11:a670bcb0e324 12:2084451ac810
     8 according to coding style. These include names of types, classes,
     8 according to coding style. These include names of types, classes,
     9 functions, variables, constants and exceptions. If these conventions
     9 functions, variables, constants and exceptions. If these conventions
    10 are met in one's code then it is easier to read and maintain
    10 are met in one's code then it is easier to read and maintain
    11 it. Please comply with these conventions if you want to contribute
    11 it. Please comply with these conventions if you want to contribute
    12 developing LEMON library.
    12 developing LEMON library.
       
    13 
       
    14 \note When the coding style requires the capitalization of an abbreviation,
       
    15 only the first letter should be upper case.
       
    16 
       
    17 \code
       
    18 XmlReader
       
    19 \endcode
       
    20 
    13 
    21 
    14 \warning In some cases we diverge from these rules.
    22 \warning In some cases we diverge from these rules.
    15 This primary done because STL uses different naming convention and
    23 This primary done because STL uses different naming convention and
    16 in certain cases
    24 in certain cases
    17 it is beneficial to provide STL compatible interface.
    25 it is beneficial to provide STL compatible interface.