Changeset 1043:52a2201a88e9 in lemon-0.x

Timestamp:

01/03/05 17:23:47 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1437

Message:

Several changes in doc

Files:

• doc/graphs.dox (modified) (3 diffs)
• doc/groups.dox (modified) (1 diff)
• doc/maps.dox (modified) (1 diff)
• src/lemon/concept/graph_component.h (modified) (1 diff)
• src/test/graph_test.cc (modified) (1 diff)
• src/work/alpar/dijkstra.h (modified) (3 diffs)

doc/graphs.dox

@@ -49 +49 @@
 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
@@ -63 +63 @@
 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.
 
@@ -191 +191 @@
 
 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".
 
 */

doc/groups.dox

@@ -24 +24 @@
 the best, most graph algorithms and auxiliary data structures can be used
 with any graph structures.
+*/
+
+/**
+@defgroup maps Maps 
+@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.
 */
 

doc/maps.dox

@@ -3 +3 @@
 
 
-\page maps Maps
+\page maps-page Maps
 
 Maps play central role in LEMON. As their name suggests, they map a

src/lemon/concept/graph_component.h

@@ -667 +667 @@
 
     /// 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>

src/test/graph_test.cc

@@ -19 +19 @@
 
 int main() {
-  ///\file
   { // checking graph components
     checkConcept<BaseGraphComponent, BaseGraphComponent >();

src/work/alpar/dijkstra.h

@@ -229 +229 @@
     ///\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,
@@ -251 +250 @@
     ///\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,
@@ -272 +271 @@
     ///\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,