doc/dirs.dox
author alpar
Fri, 03 Feb 2006 09:18:17 +0000
changeset 1949 5db4ff8d69de
parent 1416 1b481ced25e7
child 2157 f9171bfc7ebb
permissions -rw-r--r--
Fight with Doxygen.
Victory hasn't been reached yet, but it's on the horizon.
alpar@1715
     1
/**
alpar@1715
     2
\dir demo
alpar@1715
     3
\brief A collection of demo application.
alpar@1715
     4
alpar@1715
     5
This directory contains several simple demo application, mainly
alpar@1715
     6
for educational purposes.
alpar@1715
     7
*/
alpar@1715
     8
alpar@1715
     9
/**
alpar@1715
    10
\dir doc
alpar@1715
    11
\brief Auxiliary (and the whole generated) documentation.
alpar@1715
    12
 Auxiliary (and the whole generated) documentation.
alpar@1715
    13
*/
alpar@1715
    14
alpar@1715
    15
/**
alpar@1715
    16
\dir test
alpar@1715
    17
\brief Test programs.
alpar@1715
    18
alpar@1715
    19
This directory contains several test programs that check the consistency
alpar@1715
    20
of the code.
alpar@1715
    21
*/
alpar@1715
    22
alpar@1715
    23
alpar@1715
    24
alpar@1715
    25
alpar@1154
    26
/**
alpar@1154
    27
\dir lemon
alpar@1154
    28
\brief Base include directory of LEMON
alpar@1154
    29
alpar@1154
    30
This is the base directory of lemon includes, so each include file must be
alpar@1154
    31
prefixed with this, e.g.
alpar@1154
    32
\code
alpar@1154
    33
#include<lemon/list_graph.h>
alpar@1154
    34
#include<lemon/dijkstra.h>
alpar@1154
    35
\endcode
alpar@1154
    36
*/
alpar@1154
    37
alpar@1154
    38
/**
alpar@1154
    39
\dir concept
alpar@1154
    40
\brief Concept descriptors and checking classes
alpar@1154
    41
alpar@1154
    42
This directory contains the concept descriptors and concept checkers. As a user
alpar@1154
    43
you typically don't have to deal with these files.
alpar@1154
    44
*/
deba@1416
    45
deba@1416
    46
/**
deba@1416
    47
\dir bits
deba@1416
    48
\brief Implementation helper files
deba@1416
    49
deba@1416
    50
This directory contains some helper classes to implement graphs, maps and
deba@1416
    51
some other classes. As a user you typically don't have to deal with these 
deba@1416
    52
files.
deba@1416
    53
*/