COIN-OR::LEMON - Graph Library

source: lemon/doc/dirs.dox @ 154:f4e4dbc1d467

Last change on this file since 154:f4e4dbc1d467 was 40:8f4e8273a458, checked in by Alpar Juttner <alpar@…>, 16 years ago

Several doc files ported from svn -r3436

  • groups.dox contains several incomlete references
File size: 1.7 KB
Line 
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
23This directory contains several simple demo application, mainly
24for educational purposes.
25*/
26
27/**
28\dir doc
29\brief Auxiliary (and the whole generated) documentation.
30
31Auxiliary (and the whole generated) documentation.
32*/
33
34/**
35\dir test
36\brief Test programs.
37
38This directory contains several test programs that check the consistency
39of the code.
40*/
41
42/**
43\dir tools
44\brief Some useful executables
45
46This 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
56This is the base directory of lemon includes, so each include file must be
57prefixed 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
68This directory contains the concept descriptors and concept checkers. As a user
69you typically don't have to deal with these files.
70*/
71
72/**
73\dir bits
74\brief Implementation helper files
75
76This directory contains some helper classes to implement graphs, maps and
77some other classes. As a user you typically don't have to deal with these
78files.
79*/
Note: See TracBrowser for help on using the repository browser.