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