1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/doc/dirs.dox Mon Jan 07 19:22:09 2008 +0100
1.3 @@ -0,0 +1,79 @@
1.4 +/* -*- C++ -*-
1.5 + *
1.6 + * This file is a part of LEMON, a generic C++ optimization library
1.7 + *
1.8 + * Copyright (C) 2003-2008
1.9 + * Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport
1.10 + * (Egervary Research Group on Combinatorial Optimization, EGRES).
1.11 + *
1.12 + * Permission to use, modify and distribute this software is granted
1.13 + * provided that this copyright notice appears in all copies. For
1.14 + * precise terms see the accompanying LICENSE file.
1.15 + *
1.16 + * This software is provided "AS IS" with no warranty of any kind,
1.17 + * express or implied, and with no claim as to its suitability for any
1.18 + * purpose.
1.19 + *
1.20 + */
1.21 +
1.22 +/**
1.23 +\dir demo
1.24 +\brief A collection of demo application.
1.25 +
1.26 +This directory contains several simple demo application, mainly
1.27 +for educational purposes.
1.28 +*/
1.29 +
1.30 +/**
1.31 +\dir doc
1.32 +\brief Auxiliary (and the whole generated) documentation.
1.33 +
1.34 +Auxiliary (and the whole generated) documentation.
1.35 +*/
1.36 +
1.37 +/**
1.38 +\dir test
1.39 +\brief Test programs.
1.40 +
1.41 +This directory contains several test programs that check the consistency
1.42 +of the code.
1.43 +*/
1.44 +
1.45 +/**
1.46 +\dir tools
1.47 +\brief Some useful executables
1.48 +
1.49 +This directory contains the sources of some useful complete executables.
1.50 +
1.51 +*/
1.52 +
1.53 +
1.54 +
1.55 +/**
1.56 +\dir lemon
1.57 +\brief Base include directory of LEMON
1.58 +
1.59 +This is the base directory of lemon includes, so each include file must be
1.60 +prefixed with this, e.g.
1.61 +\code
1.62 +#include<lemon/list_graph.h>
1.63 +#include<lemon/dijkstra.h>
1.64 +\endcode
1.65 +*/
1.66 +
1.67 +/**
1.68 +\dir concepts
1.69 +\brief Concept descriptors and checking classes
1.70 +
1.71 +This directory contains the concept descriptors and concept checkers. As a user
1.72 +you typically don't have to deal with these files.
1.73 +*/
1.74 +
1.75 +/**
1.76 +\dir bits
1.77 +\brief Implementation helper files
1.78 +
1.79 +This directory contains some helper classes to implement graphs, maps and
1.80 +some other classes. As a user you typically don't have to deal with these
1.81 +files.
1.82 +*/