doc/dirs.dox
author deba
Thu, 15 Feb 2007 13:06:23 +0000
changeset 2362 eb37b9774ef6
parent 2157 f9171bfc7ebb
child 2390 8450951a8e2d
permissions -rw-r--r--
Small changes
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@2157
    12
alpar@2157
    13
Auxiliary (and the whole generated) documentation.
alpar@1715
    14
*/
alpar@1715
    15
alpar@1715
    16
/**
alpar@1715
    17
\dir test
alpar@1715
    18
\brief Test programs.
alpar@1715
    19
alpar@1715
    20
This directory contains several test programs that check the consistency
alpar@1715
    21
of the code.
alpar@1715
    22
*/
alpar@1715
    23
alpar@1715
    24
alpar@1715
    25
alpar@1715
    26
alpar@1154
    27
/**
alpar@1154
    28
\dir lemon
alpar@1154
    29
\brief Base include directory of LEMON
alpar@1154
    30
alpar@1154
    31
This is the base directory of lemon includes, so each include file must be
alpar@1154
    32
prefixed with this, e.g.
alpar@1154
    33
\code
alpar@1154
    34
#include<lemon/list_graph.h>
alpar@1154
    35
#include<lemon/dijkstra.h>
alpar@1154
    36
\endcode
alpar@1154
    37
*/
alpar@1154
    38
alpar@1154
    39
/**
alpar@2350
    40
\dir concepts
alpar@1154
    41
\brief Concept descriptors and checking classes
alpar@1154
    42
alpar@1154
    43
This directory contains the concept descriptors and concept checkers. As a user
alpar@1154
    44
you typically don't have to deal with these files.
alpar@1154
    45
*/
deba@1416
    46
deba@1416
    47
/**
deba@1416
    48
\dir bits
deba@1416
    49
\brief Implementation helper files
deba@1416
    50
deba@1416
    51
This directory contains some helper classes to implement graphs, maps and
deba@1416
    52
some other classes. As a user you typically don't have to deal with these 
deba@1416
    53
files.
deba@1416
    54
*/