COIN-OR::LEMON - Graph Library

Changeset 955:0a066f80e05f in lemon-0.x for doc


Ignore:
Timestamp:
11/02/04 07:28:38 (15 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1335
Message:

Improve docs.

Location:
doc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/coding_style.dox

    r921 r955  
    1212developing LEMON library.
    1313
     14\warning In some cases we diverge from these rules.
     15This primary done because STL uses different naming convention and
     16in certain cases
     17it is beneficial to provide STL compatible interface.
     18
     19\subsection cs-files File Names
     20
     21The header file names should look like the following.
     22
     23\code
     24header_file.h
     25\endcode
     26
     27Note that all standard Lemon headers are located in the \c lemon subdirectory,
     28so you should include them from C++ source like this:
     29
     30\code
     31#include <lemon/header_file.h>
     32\endcode
     33
     34The source code files use the same style and they have '.cc' extension.
     35
     36\code
     37source_code.cc
     38\endcode
     39
    1440\subsection cs-class Classes and other types
    1541
    16 The name of a class or any type should look like the following:
     42The name of a class or any type should look like the following.
    1743
    1844\code
     
    2248\subsection cs-func Methods and other functions
    2349
    24 The name of a function should look like the following:
     50The name of a function should look like the following.
    2551
    2652\code
     
    3056\subsection cs-funcs Constants, Macros
    3157
    32 The names of constants and macros should look like the following:
     58The names of constants and macros should look like the following.
    3359
    3460\code
     
    3864\subsection cs-loc-var Class and instance member variables, auto variables
    3965
    40 The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
     66The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following.
    4167
    4268\code
     
    4672\subsection cs-excep Exceptions
    4773
    48 When writing exceptions please comply the following naming conventions:
     74When writing exceptions please comply the following naming conventions.
    4975
    5076\code
     
    5278\endcode
    5379
    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.
    58 
    5980*/
  • doc/named-param.dox

    r954 r955  
    33\page named-param Named Parameters
    44
    5 \section named-templ-param Named Template Parameters
     5\section named-func-param Named "Function" Parameters
     6
     7
     8\section traits-classes Traits Classes
     9
     10\section named-templ-param Named Class Template Parameters
    611
    712Instead of creating a new traits class you can also use this adaptor class
     
    1621\endcode
    1722
     23\section named-templ-func-param Named "Function" Template Parameters
     24
    1825
    1926*/
Note: See TracChangeset for help on using the changeset viewer.