doc/dirs.dox
author hegyi
Tue, 06 Dec 2005 10:53:38 +0000
changeset 1849 a4d1362397fe
parent 1416 1b481ced25e7
child 2157 f9171bfc7ebb
permissions -rw-r--r--
Notebook style is provided. Without opportunity to close tabs. :-) But with all other necessary things (I think).
     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  Auxiliary (and the whole generated) documentation.
    13 */
    14 
    15 /**
    16 \dir test
    17 \brief Test programs.
    18 
    19 This directory contains several test programs that check the consistency
    20 of the code.
    21 */
    22 
    23 
    24 
    25 
    26 /**
    27 \dir lemon
    28 \brief Base include directory of LEMON
    29 
    30 This is the base directory of lemon includes, so each include file must be
    31 prefixed with this, e.g.
    32 \code
    33 #include<lemon/list_graph.h>
    34 #include<lemon/dijkstra.h>
    35 \endcode
    36 */
    37 
    38 /**
    39 \dir concept
    40 \brief Concept descriptors and checking classes
    41 
    42 This directory contains the concept descriptors and concept checkers. As a user
    43 you typically don't have to deal with these files.
    44 */
    45 
    46 /**
    47 \dir bits
    48 \brief Implementation helper files
    49 
    50 This directory contains some helper classes to implement graphs, maps and
    51 some other classes. As a user you typically don't have to deal with these 
    52 files.
    53 */