Doc improvments
authoralpar
Fri, 07 Oct 2005 11:05:08 +0000
changeset 1715e71778873dd0
parent 1714 66c89fe52d4e
child 1716 d8c28868f074
Doc improvments
demo/dijkstra_demo.cc
doc/dirs.dox
doc/graph_orientation.dox
     1.1 --- a/demo/dijkstra_demo.cc	Thu Oct 06 12:32:06 2005 +0000
     1.2 +++ b/demo/dijkstra_demo.cc	Fri Oct 07 11:05:08 2005 +0000
     1.3 @@ -16,7 +16,7 @@
     1.4  
     1.5  ///\ingroup demos
     1.6  ///\file
     1.7 -///\brief Demonstrating LEMON implementation of the Dijkstra algorithm
     1.8 +///\brief Demonstrating the usage of LEMON's Dijkstra algorithm
     1.9  ///
    1.10  /// Dijkstra's algorithm computes shortest paths between two nodes in
    1.11  /// a graph with edge lengths. Here we only show some of the
     2.1 --- a/doc/dirs.dox	Thu Oct 06 12:32:06 2005 +0000
     2.2 +++ b/doc/dirs.dox	Fri Oct 07 11:05:08 2005 +0000
     2.3 @@ -1,3 +1,28 @@
     2.4 +/**
     2.5 +\dir demo
     2.6 +\brief A collection of demo application.
     2.7 +
     2.8 +This directory contains several simple demo application, mainly
     2.9 +for educational purposes.
    2.10 +*/
    2.11 +
    2.12 +/**
    2.13 +\dir doc
    2.14 +\brief Auxiliary (and the whole generated) documentation.
    2.15 + Auxiliary (and the whole generated) documentation.
    2.16 +*/
    2.17 +
    2.18 +/**
    2.19 +\dir test
    2.20 +\brief Test programs.
    2.21 +
    2.22 +This directory contains several test programs that check the consistency
    2.23 +of the code.
    2.24 +*/
    2.25 +
    2.26 +
    2.27 +
    2.28 +
    2.29  /**
    2.30  \dir lemon
    2.31  \brief Base include directory of LEMON
     3.1 --- a/doc/graph_orientation.dox	Thu Oct 06 12:32:06 2005 +0000
     3.2 +++ b/doc/graph_orientation.dox	Fri Oct 07 11:05:08 2005 +0000
     3.3 @@ -101,7 +101,7 @@
     3.4  \skip active
     3.5  \until def
     3.6  
     3.7 -We also store in a bool map which edges are reverted. Actually this is only
     3.8 +We also store in a bool map indicating which edges are reverted. Actually this is only
     3.9  used to draw these edges with different color in the output picture. The
    3.10  algorithm will update this map called \c rev, but will not use it otherwise.
    3.11  \skip rev