doc/dirs.dox
 changeset 318 1e2d6ca80793 parent 209 765619b7cbb2 child 463 88ed40ad0d4f child 1078 c59bdcc8e33e
equal inserted replaced
1:f42a1d988f7b 2:ba59120e95c3
    16  *
    16  *
    17  */
    17  */
    18
    18
    19 /**
    19 /**
    20 \dir demo
    20 \dir demo
    21 \brief A collection of demo application.
    21 \brief A collection of demo applications.
    22
    22
    23 This directory contains several simple demo application, mainly
    23 This directory contains several simple demo applications, mainly
    24 for educational purposes.
    24 for educational purposes.
    25 */
    25 */
    26
    26
    27 /**
    27 /**
    28 \dir doc
    28 \dir doc
    29 \brief Auxiliary (and the whole generated) documentation.
    29 \brief Auxiliary (and the whole generated) documentation.
    30
    30
    31 Auxiliary (and the whole generated) documentation.
    31 This directory contains some auxiliary pages and the whole generated

    32 documentation.
    32 */
    33 */
    33
    34
    34 /**
    35 /**
    35 \dir test
    36 \dir test
    36 \brief Test programs.
    37 \brief Test programs.
    39 of the code.
    40 of the code.
    40 */
    41 */
    41
    42
    42 /**
    43 /**
    43 \dir tools
    44 \dir tools
    44 \brief Some useful executables
    45 \brief Some useful executables.
    45
    46
    46 This directory contains the sources of some useful complete executables.
    47 This directory contains the sources of some useful complete executables.
    48 */
    48 */
    51
    49
    52 /**
    50 /**
    53 \dir lemon
    51 \dir lemon
    54 \brief Base include directory of LEMON
    52 \brief Base include directory of LEMON.
    55
    53
    56 This is the base directory of lemon includes, so each include file must be
    54 This is the base directory of LEMON includes, so each include file must be
    57 prefixed with this, e.g.
    55 prefixed with this, e.g.
    58 \code
    56 \code
    59 #include<lemon/list_graph.h>
    57 #include<lemon/list_graph.h>
    60 #include<lemon/dijkstra.h>
    58 #include<lemon/dijkstra.h>
    61 \endcode
    59 \endcode
    62 */
    60 */
    63
    61
    64 /**
    62 /**
    65 \dir concepts
    63 \dir concepts
    66 \brief Concept descriptors and checking classes
    64 \brief Concept descriptors and checking classes.
    67
    65
    68 This directory contains the concept descriptors and concept checkers. As a user
    66 This directory contains the concept descriptors and concept checking tools.
    69 you typically don't have to deal with these files.
    67 For more information see the \ref concept "Concepts" module.
    70 */
    68 */
    71
    69
    72 /**
    70 /**
    73 \dir bits
    71 \dir bits
    74 \brief Implementation helper files
    72 \brief Auxiliary tools for implementation.
    75
    73
    76 This directory contains some helper classes to implement graphs, maps and
    74 This directory contains some auxiliary classes for implementing graphs,
    77 some other classes. As a user you typically don't have to deal with these
    75 maps and some other classes.
    78 files.
    76 As a user you typically don't have to deal with these files.
    79 */
    77 */