doc/dirs.dox
author Peter Kovacs <kpeter@inf.elte.hu>
Sun, 03 Aug 2008 13:34:57 +0200
changeset 244 c30731a37f91
parent 40 8f4e8273a458
child 318 1e2d6ca80793
permissions -rw-r--r--
Many improvements in bfs.h, dfs.h and dijkstra.h
- Add run() function to Bfs and run(s,t) function to DfsVisit.
- Add debug checking to addSource() function of Dfs and DfsVisit.
- Add a few missing named parameters (according to \todo notes).
- Small fixes in the code (e.g. missing derivations).
- Many doc improvements.
- Remove \todo and \warning comments which are no longer valid.
- Remove \author commands (see ticket #39).
- Fixes in the the doc (e.g. wrong references).
- Hide the doc of most of the private and protected members.
- Use public typedefs instead of template parameters in public functions.
- Use better parameter names for some functions.
- Other small changes to make the doc more uniform.
     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-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 
    23 This directory contains several simple demo application, mainly
    24 for educational purposes.
    25 */
    26 
    27 /**
    28 \dir doc
    29 \brief Auxiliary (and the whole generated) documentation.
    30 
    31 Auxiliary (and the whole generated) documentation.
    32 */
    33 
    34 /**
    35 \dir test
    36 \brief Test programs.
    37 
    38 This directory contains several test programs that check the consistency
    39 of the code.
    40 */
    41 
    42 /**
    43 \dir tools
    44 \brief Some useful executables
    45 
    46 This 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 
    56 This is the base directory of lemon includes, so each include file must be
    57 prefixed 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 
    68 This directory contains the concept descriptors and concept checkers. As a user
    69 you typically don't have to deal with these files.
    70 */
    71 
    72 /**
    73 \dir bits
    74 \brief Implementation helper files
    75 
    76 This directory contains some helper classes to implement graphs, maps and
    77 some other classes. As a user you typically don't have to deal with these
    78 files.
    79 */