Changeset 825:738abd9d1262 in lemon-0.x for src

Timestamp:

09/09/04 09:09:41 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Improved docs.

Location:

src

Files:

• hugo/list_graph.h (modified) (4 diffs)
• test/test_tools.h (modified) (2 diffs)

src/hugo/list_graph.h

@@ -26 +26 @@
 /// @{
 
-//  class SymListGraph;
-
   ///A list graph class.
 
@@ -33 +31 @@
   ///
   ///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 {
 
@@ -43 +41 @@
       int first_in,first_out;
       int prev, next;
-      //      NodeT() {}
     };
     //Edges are double linked.
@@ -52 +49 @@
       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) {}  
     };
 

src/test/test_tools.h

@@ -35 +35 @@
 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;
 };
 
@@ -46 +52 @@
 
 ///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>