Changeset 606:c5fd2d996909 in lemon for lemon/list_graph.h

Timestamp:

03/29/09 23:08:20 (15 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Various doc improvements (#248)

• Rename all the ugly template parameters (too long and/or starting with an underscore).
• Rename function parameters starting with an underscore.
• Extend the doc for many classes.
• Use LaTeX-style O(...) expressions only for the complicated ones.
• A lot of small unification changes.
• Small fixes.
• Some other improvements.

File:

• lemon/list_graph.h (modified) (4 diffs)

lemon/list_graph.h

@@ -352 +352 @@
 
     ///Add a new node to the digraph.
-    ///\return the new node.
+    ///\return The new node.
     Node addNode() { return Parent::addNode(); }
 
@@ -359 +359 @@
     ///Add a new arc to the digraph with source node \c s
     ///and target node \c t.
-    ///\return the new arc.
+    ///\return The new arc.
     Arc addArc(const Node& s, const Node& t) {
       return Parent::addArc(s, t);
@@ -1209 +1209 @@
     ///
     /// Add a new node to the graph.
-    /// \return the new node.
+    /// \return The new node.
     Node addNode() { return Parent::addNode(); }
 
@@ -1216 +1216 @@
     /// Add a new edge to the graph with source node \c s
     /// and target node \c t.
-    /// \return the new edge.
+    /// \return The new edge.
     Edge addEdge(const Node& s, const Node& t) {
       return Parent::addEdge(s, t);