[Lemon-commits] [lemon_svn] alpar: r1121 - in hugo/trunk/src: hugo test

[Lemon SVN]

Author: alpar
Date: Thu Sep  9 09:09:41 2004
New Revision: 1121

Modified:
   hugo/trunk/src/hugo/list_graph.h
   hugo/trunk/src/test/test_tools.h

Log:
Improved docs.


Modified: hugo/trunk/src/hugo/list_graph.h
==============================================================================
--- hugo/trunk/src/hugo/list_graph.h	(original)
+++ hugo/trunk/src/hugo/list_graph.h	Thu Sep  9 09:09:41 2004
@@ -25,15 +25,13 @@
 /// \addtogroup graphs
 /// @{
 
-//  class SymListGraph;
-
   ///A list graph class.
 
   ///This is a simple and fast erasable graph implementation.
   ///
   ///It conforms to the graph interface documented under
-  ///the description of \ref GraphSkeleton.
-  ///\sa \ref GraphSkeleton.
+  ///the description of \ref ErasableGraphSkeleton.
+  ///\sa \ref ErasableGraphSkeleton.
   class ListGraph {
 
     //Nodes are double linked.
@@ -42,7 +40,6 @@
     {
       int first_in,first_out;
       int prev, next;
-      //      NodeT() {}
     };
     //Edges are double linked.
     //The free edges are only single linked using the "next_in" field.
@@ -51,8 +48,6 @@
       int head, tail;
       int prev_in, prev_out;
       int next_in, next_out;
-      //FIXME: is this necessary?
-      //      EdgeT() : next_in(-1), next_out(-1) prev_in(-1), prev_out(-1) {}  
     };
 
     std::vector<NodeT> nodes;

Modified: hugo/trunk/src/test/test_tools.h
==============================================================================
--- hugo/trunk/src/test/test_tools.h	(original)
+++ hugo/trunk/src/test/test_tools.h	Thu Sep  9 09:09:41 2004
@@ -34,10 +34,16 @@
 ///
 template<class Graph> struct PetStruct
 {
-  ///.
-  std::vector<typename Graph::Node> outer, inner;
-  ///.
-  std::vector<typename Graph::Edge> outcir, incir, chords;
+  ///Vector containing the outer nodes.
+  std::vector<typename Graph::Node> outer;
+  ///Vector containing the inner nodes.
+  std::vector<typename Graph::Node> inner;
+  ///Vector containing the edges of the inner circle.
+  std::vector<typename Graph::Edge> incir;
+  ///Vector containing the edges of the outer circle.
+  std::vector<typename Graph::Edge> outcir;
+  ///Vector containing the chord edges.
+  std::vector<typename Graph::Edge> chords;
 };
 
 
@@ -45,7 +51,7 @@
 ///Adds a Petersen graph to \c G.
 
 ///Adds a Petersen graph to \c G.
-///The nodes end edges will be listed in the return structure.
+///\return The nodes end edges og the generated graph.
 
 template<typename Graph>
 PetStruct<Graph> addPetersen(Graph &G,int num=5)