Several changes in doc
authoralpar
Mon, 03 Jan 2005 16:23:47 +0000
changeset 104352a2201a88e9
parent 1042 9c5daf8e3e32
child 1044 f97380557656
Several changes in doc
doc/graphs.dox
doc/groups.dox
doc/maps.dox
src/lemon/concept/graph_component.h
src/test/graph_test.cc
src/work/alpar/dijkstra.h
     1.1 --- a/doc/graphs.dox	Mon Jan 03 16:21:33 2005 +0000
     1.2 +++ b/doc/graphs.dox	Mon Jan 03 16:23:47 2005 +0000
     1.3 @@ -48,8 +48,8 @@
     1.4  implements a full graph. It is a \ref lemon::concept::StaticGraph, so you cannot
     1.5  change the number of nodes once it is constructed. It is extremely memory
     1.6  efficient: it uses constant amount of memory independently from the number of
     1.7 -the nodes of the graph. Of course, the size of the \ref maps "NodeMap"'s and
     1.8 -\ref maps "EdgeMap"'s will depend on the number of nodes.
     1.9 +the nodes of the graph. Of course, the size of the \ref maps-page "NodeMap"'s and
    1.10 +\ref maps-page "EdgeMap"'s will depend on the number of nodes.
    1.11  
    1.12  \li \ref lemon::NodeSet "NodeSet" implements a graph with no edges. This class
    1.13  can be used as a base class of \ref lemon::EdgeSet "EdgeSet".
    1.14 @@ -62,7 +62,7 @@
    1.15  
    1.16  The graph structures itself can not store data attached
    1.17  to the edges and nodes. However they all provide
    1.18 -\ref maps "map classes"
    1.19 +\ref maps-page "map classes"
    1.20  to dynamically attach data the to graph components.
    1.21  
    1.22  The following program demonstrates the basic features of LEMON's graph
    1.23 @@ -190,6 +190,6 @@
    1.24  into the map and the operator[] to retrieve them.
    1.25  
    1.26  Here we used the maps provided by the ListGraph class, but you can also write
    1.27 -your own maps. You can read more about using maps \ref maps "here".
    1.28 +your own maps. You can read more about using maps \ref maps-page "here".
    1.29  
    1.30  */
     2.1 --- a/doc/groups.dox	Mon Jan 03 16:21:33 2005 +0000
     2.2 +++ b/doc/groups.dox	Mon Jan 03 16:23:47 2005 +0000
     2.3 @@ -26,6 +26,15 @@
     2.4  */
     2.5  
     2.6  /**
     2.7 +@defgroup maps Maps 
     2.8 +@ingroup datas
     2.9 +\brief Some special purpose map to make life easier.
    2.10 +
    2.11 +LEMON provides several special maps that e.g. combine
    2.12 +new maps from existing ones.
    2.13 +*/
    2.14 +
    2.15 +/**
    2.16  @defgroup auxdat Auxiliary Data Structures
    2.17  @ingroup datas
    2.18  \brief Some data structures implemented in LEMON.
     3.1 --- a/doc/maps.dox	Mon Jan 03 16:21:33 2005 +0000
     3.2 +++ b/doc/maps.dox	Mon Jan 03 16:23:47 2005 +0000
     3.3 @@ -2,7 +2,7 @@
     3.4  
     3.5  
     3.6  
     3.7 -\page maps Maps
     3.8 +\page maps-page Maps
     3.9  
    3.10  Maps play central role in LEMON. As their name suggests, they map a
    3.11  certain range of \e keys to certain \e values. Each map has two
     4.1 --- a/src/lemon/concept/graph_component.h	Mon Jan 03 16:21:33 2005 +0000
     4.2 +++ b/src/lemon/concept/graph_component.h	Mon Jan 03 16:23:47 2005 +0000
     4.3 @@ -666,7 +666,7 @@
     4.4      /// Class describing the concept of graph maps
     4.5  
     4.6      /// This class describes the common interface of the graph maps
     4.7 -    /// (NodeMap, EdgeMap), that is \ref maps "maps" which can be used to
     4.8 +    /// (NodeMap, EdgeMap), that is \ref maps-pages "maps" which can be used to
     4.9      /// associate data to graph descriptors (nodes or edges).
    4.10      template <typename Graph, typename Item, typename _Value>
    4.11      class GraphMap : public ReadWriteMap<Item, _Value> {
     5.1 --- a/src/test/graph_test.cc	Mon Jan 03 16:21:33 2005 +0000
     5.2 +++ b/src/test/graph_test.cc	Mon Jan 03 16:23:47 2005 +0000
     5.3 @@ -18,7 +18,6 @@
     5.4  
     5.5  
     5.6  int main() {
     5.7 -  ///\file
     5.8    { // checking graph components
     5.9      checkConcept<BaseGraphComponent, BaseGraphComponent >();
    5.10  
     6.1 --- a/src/work/alpar/dijkstra.h	Mon Jan 03 16:21:33 2005 +0000
     6.2 +++ b/src/work/alpar/dijkstra.h	Mon Jan 03 16:23:47 2005 +0000
     6.3 @@ -228,9 +228,8 @@
     6.4      };
     6.5      ///\ref named-templ-param "Named parameter" for setting PredMap type
     6.6  
     6.7 -    ///\relates Dijkstra
     6.8 -    ///\ingroup flowalgs 
     6.9      ///\ref named-templ-param "Named parameter" for setting PredMap type
    6.10 +    ///
    6.11      template <class T>
    6.12      class SetPredMap : public Dijkstra< Graph,
    6.13  					LengthMap,
    6.14 @@ -250,8 +249,8 @@
    6.15      };
    6.16      ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
    6.17  
    6.18 -    ///\ingroup flowalgs 
    6.19      ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
    6.20 +    ///
    6.21      template <class T>
    6.22      class SetPredNodeMap : public Dijkstra< Graph,
    6.23  					    LengthMap,
    6.24 @@ -271,8 +270,8 @@
    6.25      };
    6.26      ///\ref named-templ-param "Named parameter" for setting DistMap type
    6.27  
    6.28 -    ///\ingroup flowalgs 
    6.29      ///\ref named-templ-param "Named parameter" for setting DistMap type
    6.30 +    ///
    6.31      template <class T>
    6.32      class SetDistMap : public Dijkstra< Graph,
    6.33  					LengthMap,