alpar@507: /*!
alpar@507: 
alpar@509: \page coding_style Hugo Coding Style 
alpar@507: 
athos@603: \section Naming Conventions
alpar@507: 
alpar@667: In order to make development easier we have made some conventions
alpar@667: according to coding style. These include names of types, classes,
alpar@667: functions, variables, constants and exceptions. If these conventions
alpar@667: are met in one's code then it is easier to read and maintain
alpar@667: it. Please comply with these conventions if you want to contribute
alpar@667: developing Hugo library.
athos@603: 
alpar@614: \subsection cs-class Classes and other types
athos@603: 
athos@603: The name of a class or any type should look like the following:
alpar@507: 
alpar@507: \code
alpar@507: AllWordsCapitalizedWithoutUnderscores 
alpar@507: \endcode
alpar@507: 
alpar@614: \subsection cs-func Methods and other functions
athos@603: 
athos@603: The name of a function should look like the following:
alpar@507: 
alpar@507: \code
alpar@507: firstWordLowerCaseRestCapitalizedWithoutUnderscores 
alpar@507: \endcode
alpar@507: 
alpar@614: \subsection cs-funcs Constants, Macros
athos@603: 
athos@603: The names of constants and macros should look like the following:
alpar@507: 
alpar@507: \code
alpar@507: ALL_UPPER_CASE_WITH_UNDERSCORES 
alpar@507: \endcode
alpar@507: 
alpar@614: \subsection cs-loc-var Class and instance member variables, auto variables 
alpar@507: 
athos@603: The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
alpar@507: 
alpar@507: \code
alpar@507: all_lower_case_with_underscores 
alpar@507: \endcode
alpar@507: 
alpar@614: \subsection cs-excep Exceptions
alpar@507: 
athos@603: When writing exceptions please comply the following naming conventions:
athos@603: 
alpar@507: \code
alpar@507: ClassNameEndsWithException
alpar@507: \endcode
alpar@507: 
alpar@507: 
alpar@507: */