doc/dirs.dox
 author Alpar Juttner Thu, 04 Aug 2011 22:00:57 +0200 changeset 924 3dcb45a871c3 parent 209 765619b7cbb2 child 440 88ed40ad0d4f permissions -rw-r--r--
Update the AUTHORS file
     1 /* -*- mode: C++; indent-tabs-mode: nil; -*-

     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 applications.

    22

    23 This directory contains several simple demo applications, mainly

    24 for educational purposes.

    25 */

    26

    27 /**

    28 \dir doc

    29 \brief Auxiliary (and the whole generated) documentation.

    30

    31 This directory contains some auxiliary pages and the whole generated

    32 documentation.

    33 */

    34

    35 /**

    36 \dir test

    37 \brief Test programs.

    38

    39 This directory contains several test programs that check the consistency

    40 of the code.

    41 */

    42

    43 /**

    44 \dir tools

    45 \brief Some useful executables.

    46

    47 This directory contains the sources of some useful complete executables.

    48 */

    49

    50 /**

    51 \dir lemon

    52 \brief Base include directory of LEMON.

    53

    54 This is the base directory of LEMON includes, so each include file must be

    55 prefixed with this, e.g.

    56 \code

    57 #include<lemon/list_graph.h>

    58 #include<lemon/dijkstra.h>

    59 \endcode

    60 */

    61

    62 /**

    63 \dir concepts

    64 \brief Concept descriptors and checking classes.

    65

    66 This directory contains the concept descriptors and concept checking tools.

    67 For more information see the \ref concept "Concepts" module.

    68 */

    69

    70 /**

    71 \dir bits

    72 \brief Auxiliary tools for implementation.

    73

    74 This directory contains some auxiliary classes for implementing graphs,

    75 maps and some other classes.

    76 As a user you typically don't have to deal with these files.

    77 */