doc/coding_style.dox
changeset 913 f2acaefc721c
parent 667 9cba4444d804
child 921 818510fa3d99
equal deleted inserted replaced
5:81d44336ac6e 6:000f19e75d68
     1 /*!
     1 /*!
     2 
     2 
     3 \page coding_style Hugo Coding Style 
     3 \page coding_style Hugo Coding Style 
     4 
     4 
     5 \section Naming Conventions
     5 \section naming_conv Naming Conventions
     6 
     6 
     7 In order to make development easier we have made some conventions
     7 In order to make development easier we have made some conventions
     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
    49 
    49 
    50 \code
    50 \code
    51 ClassNameEndsWithException
    51 ClassNameEndsWithException
    52 \endcode
    52 \endcode
    53 
    53 
       
    54 \warning In some cases we diverge from these rules.
       
    55 This primary done because STL uses different naming convention and
       
    56 in certain cases
       
    57 it is beneficial to provide STL compatible interface.
    54 
    58 
    55 */
    59 */