Description of the LEMON directories.
authoralpar
Fri, 18 Feb 2005 10:36:13 +0000
changeset 1154f07c1c442e6c
parent 1153 4b0468de3a31
child 1155 fe0fcdb5687b
Description of the LEMON directories.
doc/dirs.dox
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/doc/dirs.dox	Fri Feb 18 10:36:13 2005 +0000
     1.3 @@ -0,0 +1,19 @@
     1.4 +/**
     1.5 +\dir lemon
     1.6 +\brief Base include directory of LEMON
     1.7 +
     1.8 +This is the base directory of lemon includes, so each include file must be
     1.9 +prefixed with this, e.g.
    1.10 +\code
    1.11 +#include<lemon/list_graph.h>
    1.12 +#include<lemon/dijkstra.h>
    1.13 +\endcode
    1.14 +*/
    1.15 +
    1.16 +/**
    1.17 +\dir concept
    1.18 +\brief Concept descriptors and checking classes
    1.19 +
    1.20 +This directory contains the concept descriptors and concept checkers. As a user
    1.21 +you typically don't have to deal with these files.
    1.22 +*/