doc/dirs.dox
author alpar
Sat, 03 Mar 2007 16:04:50 +0000
changeset 2390 8450951a8e2d
parent 2350 eb371753e814
child 2391 14a343be7a5a
permissions -rw-r--r--
- '-Wshadow' seemed to strict therefore removed
- a tools directory added for useful executables codes
- tools/lgf-gen.cc (a random graph generator) added
     1 /**
     2 \dir demo
     3 \brief A collection of demo application.
     4 
     5 This directory contains several simple demo application, mainly
     6 for educational purposes.
     7 */
     8 
     9 /**
    10 \dir doc
    11 \brief Auxiliary (and the whole generated) documentation.
    12 
    13 Auxiliary (and the whole generated) documentation.
    14 */
    15 
    16 /**
    17 \dir test
    18 \brief Test programs.
    19 
    20 This directory contains several test programs that check the consistency
    21 of the code.
    22 */
    23 
    24 /**
    25 \dir tools
    26 \brief Some useful executables
    27 
    28 This directory contains the sources of some useful complete executables.
    29 
    30 */
    31 
    32 
    33 
    34 /**
    35 \dir lemon
    36 \brief Base include directory of LEMON
    37 
    38 This is the base directory of lemon includes, so each include file must be
    39 prefixed with this, e.g.
    40 \code
    41 #include<lemon/list_graph.h>
    42 #include<lemon/dijkstra.h>
    43 \endcode
    44 */
    45 
    46 /**
    47 \dir concepts
    48 \brief Concept descriptors and checking classes
    49 
    50 This directory contains the concept descriptors and concept checkers. As a user
    51 you typically don't have to deal with these files.
    52 */
    53 
    54 /**
    55 \dir bits
    56 \brief Implementation helper files
    57 
    58 This directory contains some helper classes to implement graphs, maps and
    59 some other classes. As a user you typically don't have to deal with these 
    60 files.
    61 */