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