[Lemon-commits] [lemon_svn] alpar: r1437 - in hugo/trunk: doc src/lemon/concept src/test src/work/alpar

[Lemon SVN]

Author: alpar
Date: Mon Jan  3 17:23:47 2005
New Revision: 1437

Modified:
   hugo/trunk/doc/graphs.dox
   hugo/trunk/doc/groups.dox
   hugo/trunk/doc/maps.dox
   hugo/trunk/src/lemon/concept/graph_component.h
   hugo/trunk/src/test/graph_test.cc
   hugo/trunk/src/work/alpar/dijkstra.h

Log:
Several changes in doc

Modified: hugo/trunk/doc/graphs.dox
==============================================================================
--- hugo/trunk/doc/graphs.dox	(original)
+++ hugo/trunk/doc/graphs.dox	Mon Jan  3 17:23:47 2005
@@ -48,8 +48,8 @@
 implements a full graph. It is a \ref lemon::concept::StaticGraph, so you cannot
 change the number of nodes once it is constructed. It is extremely memory
 efficient: it uses constant amount of memory independently from the number of
-the nodes of the graph. Of course, the size of the \ref maps "NodeMap"'s and
-\ref maps "EdgeMap"'s will depend on the number of nodes.
+the nodes of the graph. Of course, the size of the \ref maps-page "NodeMap"'s and
+\ref maps-page "EdgeMap"'s will depend on the number of nodes.
 
 \li \ref lemon::NodeSet "NodeSet" implements a graph with no edges. This class
 can be used as a base class of \ref lemon::EdgeSet "EdgeSet".
@@ -62,7 +62,7 @@
 
 The graph structures itself can not store data attached
 to the edges and nodes. However they all provide
-\ref maps "map classes"
+\ref maps-page "map classes"
 to dynamically attach data the to graph components.
 
 The following program demonstrates the basic features of LEMON's graph
@@ -190,6 +190,6 @@
 into the map and the operator[] to retrieve them.
 
 Here we used the maps provided by the ListGraph class, but you can also write
-your own maps. You can read more about using maps \ref maps "here".
+your own maps. You can read more about using maps \ref maps-page "here".
 
 */

Modified: hugo/trunk/doc/groups.dox
==============================================================================
--- hugo/trunk/doc/groups.dox	(original)
+++ hugo/trunk/doc/groups.dox	Mon Jan  3 17:23:47 2005
@@ -26,6 +26,15 @@
 */
 
 /**
+ at defgroup maps Maps 
+ at ingroup datas
+\brief Some special purpose map to make life easier.
+
+LEMON provides several special maps that e.g. combine
+new maps from existing ones.
+*/
+
+/**
 @defgroup auxdat Auxiliary Data Structures
 @ingroup datas
 \brief Some data structures implemented in LEMON.

Modified: hugo/trunk/doc/maps.dox
==============================================================================
--- hugo/trunk/doc/maps.dox	(original)
+++ hugo/trunk/doc/maps.dox	Mon Jan  3 17:23:47 2005
@@ -2,7 +2,7 @@
 
 
 
-\page maps Maps
+\page maps-page Maps
 
 Maps play central role in LEMON. As their name suggests, they map a
 certain range of \e keys to certain \e values. Each map has two

Modified: hugo/trunk/src/lemon/concept/graph_component.h
==============================================================================
--- hugo/trunk/src/lemon/concept/graph_component.h	(original)
+++ hugo/trunk/src/lemon/concept/graph_component.h	Mon Jan  3 17:23:47 2005
@@ -666,7 +666,7 @@
     /// Class describing the concept of graph maps
 
     /// This class describes the common interface of the graph maps
-    /// (NodeMap, EdgeMap), that is \ref maps "maps" which can be used to
+    /// (NodeMap, EdgeMap), that is \ref maps-pages "maps" which can be used to
     /// associate data to graph descriptors (nodes or edges).
     template <typename Graph, typename Item, typename _Value>
     class GraphMap : public ReadWriteMap<Item, _Value> {

Modified: hugo/trunk/src/test/graph_test.cc
==============================================================================
--- hugo/trunk/src/test/graph_test.cc	(original)
+++ hugo/trunk/src/test/graph_test.cc	Mon Jan  3 17:23:47 2005
@@ -18,7 +18,6 @@
 
 
 int main() {
-  ///\file
   { // checking graph components
     checkConcept<BaseGraphComponent, BaseGraphComponent >();
 

Modified: hugo/trunk/src/work/alpar/dijkstra.h
==============================================================================
--- hugo/trunk/src/work/alpar/dijkstra.h	(original)
+++ hugo/trunk/src/work/alpar/dijkstra.h	Mon Jan  3 17:23:47 2005
@@ -228,9 +228,8 @@
     };
     ///\ref named-templ-param "Named parameter" for setting PredMap type
 
-    ///\relates Dijkstra
-    ///\ingroup flowalgs 
     ///\ref named-templ-param "Named parameter" for setting PredMap type
+    ///
     template <class T>
     class SetPredMap : public Dijkstra< Graph,
 					LengthMap,
@@ -250,8 +249,8 @@
     };
     ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
 
-    ///\ingroup flowalgs 
     ///\ref named-templ-param "Named parameter" for setting PredNodeMap type
+    ///
     template <class T>
     class SetPredNodeMap : public Dijkstra< Graph,
 					    LengthMap,
@@ -271,8 +270,8 @@
     };
     ///\ref named-templ-param "Named parameter" for setting DistMap type
 
-    ///\ingroup flowalgs 
     ///\ref named-templ-param "Named parameter" for setting DistMap type
+    ///
     template <class T>
     class SetDistMap : public Dijkstra< Graph,
 					LengthMap,