doc/dirs.dox
changeset 161 2c999941b871
child 209 765619b7cbb2
equal deleted inserted replaced
-1:000000000000 0:eb57998e7dc0
       
     1 /* -*- C++ -*-
       
     2  *
       
     3  * This file is a part of LEMON, a generic C++ optimization library
       
     4  *
       
     5  * Copyright (C) 2003-2008
       
     6  * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
       
     7  * (Egervary Research Group on Combinatorial Optimization, EGRES).
       
     8  *
       
     9  * Permission to use, modify and distribute this software is granted
       
    10  * provided that this copyright notice appears in all copies. For
       
    11  * precise terms see the accompanying LICENSE file.
       
    12  *
       
    13  * This software is provided "AS IS" with no warranty of any kind,
       
    14  * express or implied, and with no claim as to its suitability for any
       
    15  * purpose.
       
    16  *
       
    17  */
       
    18 
       
    19 /**
       
    20 \dir demo
       
    21 \brief A collection of demo application.
       
    22 
       
    23 This directory contains several simple demo application, mainly
       
    24 for educational purposes.
       
    25 */
       
    26 
       
    27 /**
       
    28 \dir doc
       
    29 \brief Auxiliary (and the whole generated) documentation.
       
    30 
       
    31 Auxiliary (and the whole generated) documentation.
       
    32 */
       
    33 
       
    34 /**
       
    35 \dir test
       
    36 \brief Test programs.
       
    37 
       
    38 This directory contains several test programs that check the consistency
       
    39 of the code.
       
    40 */
       
    41 
       
    42 /**
       
    43 \dir tools
       
    44 \brief Some useful executables
       
    45 
       
    46 This directory contains the sources of some useful complete executables.
       
    47 
       
    48 */
       
    49 
       
    50 
       
    51 
       
    52 /**
       
    53 \dir lemon
       
    54 \brief Base include directory of LEMON
       
    55 
       
    56 This is the base directory of lemon includes, so each include file must be
       
    57 prefixed with this, e.g.
       
    58 \code
       
    59 #include<lemon/list_graph.h>
       
    60 #include<lemon/dijkstra.h>
       
    61 \endcode
       
    62 */
       
    63 
       
    64 /**
       
    65 \dir concepts
       
    66 \brief Concept descriptors and checking classes
       
    67 
       
    68 This directory contains the concept descriptors and concept checkers. As a user
       
    69 you typically don't have to deal with these files.
       
    70 */
       
    71 
       
    72 /**
       
    73 \dir bits
       
    74 \brief Implementation helper files
       
    75 
       
    76 This directory contains some helper classes to implement graphs, maps and
       
    77 some other classes. As a user you typically don't have to deal with these 
       
    78 files.
       
    79 */