COIN-OR::LEMON - Graph Library

source: lemon/doc/dirs.dox @ 1270:dceba191c00d

Last change on this file since 1270:dceba191c00d was 1270:dceba191c00d, checked in by Alpar Juttner <alpar@…>, 6 years ago

Apply unify-sources.sh to the source tree

File size: 2.3 KB
Line 
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-2013
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
23This directory contains several simple demo applications, mainly
24for educational purposes.
25*/
26
27/**
28\dir doc
29\brief Auxiliary (and the whole generated) documentation.
30
31This directory contains some auxiliary pages and the whole generated
32documentation.
33*/
34
35/**
36\dir contrib
37\brief Directory for user contributed source codes.
38
39You can place your own C++ code using LEMON into this directory, which
40will compile to an executable along with LEMON when you build the
41library. This is probably the easiest way of compiling short to medium
42codes, for this does require neither a LEMON installed system-wide nor
43adding several paths to the compiler.
44
45Please have a look at <tt>contrib/CMakeLists.txt</tt> for
46instruction on how to add your own files into the build process.  */
47
48/**
49\dir test
50\brief Test programs.
51
52This directory contains several test programs that check the consistency
53of the code.
54*/
55
56/**
57\dir tools
58\brief Some useful executables.
59
60This directory contains the sources of some useful complete executables.
61*/
62
63/**
64\dir lemon
65\brief Base include directory of LEMON.
66
67This is the base directory of LEMON includes, so each include file must be
68prefixed with this, e.g.
69\code
70#include<lemon/list_graph.h>
71#include<lemon/dijkstra.h>
72\endcode
73*/
74
75/**
76\dir concepts
77\brief Concept descriptors and checking classes.
78
79This directory contains the concept descriptors and concept checking tools.
80For more information see the \ref concept "Concepts" module.
81*/
82
83/**
84\dir bits
85\brief Auxiliary tools for implementation.
86
87This directory contains some auxiliary classes for implementing graphs,
88maps and some other classes.
89As a user you typically don't have to deal with these files.
90*/
Note: See TracBrowser for help on using the repository browser.