doc/dirs.dox
author alpar
Tue, 06 Feb 2007 19:09:17 +0000
changeset 2354 3609c77b77be
parent 2157 f9171bfc7ebb
child 2390 8450951a8e2d
permissions -rw-r--r--
Doc improvements
     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 
    26 
    27 /**
    28 \dir lemon
    29 \brief Base include directory of LEMON
    30 
    31 This is the base directory of lemon includes, so each include file must be
    32 prefixed with this, e.g.
    33 \code
    34 #include<lemon/list_graph.h>
    35 #include<lemon/dijkstra.h>
    36 \endcode
    37 */
    38 
    39 /**
    40 \dir concepts
    41 \brief Concept descriptors and checking classes
    42 
    43 This directory contains the concept descriptors and concept checkers. As a user
    44 you typically don't have to deal with these files.
    45 */
    46 
    47 /**
    48 \dir bits
    49 \brief Implementation helper files
    50 
    51 This directory contains some helper classes to implement graphs, maps and
    52 some other classes. As a user you typically don't have to deal with these 
    53 files.
    54 */