COIN-OR::LEMON - Graph Library

source: lemon-1.2/doc/dirs.dox @ 416:76287c8caa26

Last change on this file since 416:76287c8caa26 was 318:1e2d6ca80793, checked in by Peter Kovacs <kpeter@…>, 16 years ago

Doc improvements

File size: 1.8 KB
RevLine 
[209]1/* -*- mode: C++; indent-tabs-mode: nil; -*-
[40]2 *
[209]3 * This file is a part of LEMON, a generic C++ optimization library.
[40]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
[318]21\brief A collection of demo applications.
[40]22
[318]23This directory contains several simple demo applications, mainly
[40]24for educational purposes.
25*/
26
27/**
28\dir doc
29\brief Auxiliary (and the whole generated) documentation.
30
[318]31This directory contains some auxiliary pages and the whole generated
32documentation.
[40]33*/
34
35/**
36\dir test
37\brief Test programs.
38
39This directory contains several test programs that check the consistency
40of the code.
41*/
42
43/**
44\dir tools
[318]45\brief Some useful executables.
[40]46
47This directory contains the sources of some useful complete executables.
48*/
49
50/**
51\dir lemon
[318]52\brief Base include directory of LEMON.
[40]53
[318]54This is the base directory of LEMON includes, so each include file must be
[40]55prefixed 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
[318]64\brief Concept descriptors and checking classes.
[40]65
[318]66This directory contains the concept descriptors and concept checking tools.
67For more information see the \ref concept "Concepts" module.
[40]68*/
69
70/**
71\dir bits
[318]72\brief Auxiliary tools for implementation.
[40]73
[318]74This directory contains some auxiliary classes for implementing graphs,
75maps and some other classes.
76As a user you typically don't have to deal with these files.
[40]77*/
Note: See TracBrowser for help on using the repository browser.