[Lemon-commits] [lemon_svn] deba: r2329 - hugo/trunk/doc

[Lemon SVN]

Author: deba
Date: Mon Nov 14 19:34:16 2005
New Revision: 2329

Modified:
   hugo/trunk/doc/coding_style.dox
   hugo/trunk/doc/graph_io.dox
   hugo/trunk/doc/maps.dox

Log:
Some documentation modifications



Modified: hugo/trunk/doc/coding_style.dox
==============================================================================
--- hugo/trunk/doc/coding_style.dox	(original)
+++ hugo/trunk/doc/coding_style.dox	Mon Nov 14 19:34:16 2005
@@ -77,6 +77,12 @@
 ClassNameEndsWithException
 \endcode
 
+or
+
+\code
+ClassNameEndsWithError
+\endcode
+
 \section header-template Template Header File
 
 Each LEMON header file should look like this:

Modified: hugo/trunk/doc/graph_io.dox
==============================================================================
--- hugo/trunk/doc/graph_io.dox	(original)
+++ hugo/trunk/doc/graph_io.dox	Mon Nov 14 19:34:16 2005
@@ -110,10 +110,6 @@
 
 \section use Using graph input-output
 
-The easiest way of using graph input and output is using the versions of the
-  public \ref readGraph() and \ref writeGraph() functions; if you don't need
-  very sophisticated behaviour then you might be satisfied with
-  those. Otherwise go on reading this page.
 
 The graph input and output is based on <em> reading and writing
 commands</em>. The user gives reading and writing commands to the reader or
@@ -361,7 +357,7 @@
 the \ref lemon::UndirGraphReader "UndirGraphReader"
 and \ref lemon::UndirGraphWriter "UndirGraphWriter".
 
-The \ref lemon::UndirGraphReader::readUndirMap() "readUndirMap()"
+The \ref lemon::UndirGraphReader::readUndirEdgeMap() "readUndirEdgeMap()"
 function reads an undirected map and the
 \ref lemon::UndirGraphReader::readUndirEdge() "readUndirEdge()"
 reads an undirected edge from the file, 

Modified: hugo/trunk/doc/maps.dox
==============================================================================
--- hugo/trunk/doc/maps.dox	(original)
+++ hugo/trunk/doc/maps.dox	Mon Nov 14 19:34:16 2005
@@ -27,14 +27,14 @@
 Each graph structure in LEMON provides two standard map templates called
 \c EdgeMap and \c NodeMap. Both are reference maps and you can easily
 assign data to the nodes and to the edges of the graph. For example if you
-have a graph \c G defined as
+have a graph \c g defined as
 \code
-  ListGraph G;
+  ListGraph g;
 \endcode
 and you want to assign a floating point value to each edge, you can do
 it like this.
 \code
-  ListGraph::EdgeMap<double> length(G);
+  ListGraph::EdgeMap<double> length(g);
 \endcode
 Note that you must give the underlying graph to the constructor.
 
@@ -94,8 +94,6 @@
 
 An alternative way to define maps is to use \c MapBase
 
-\todo For this, \c MapBase seems to be a better name then \c NullMap.
-
 \code
 struct MyMap : public MapBase<Graph::Edge,double>
 {
@@ -116,13 +114,13 @@
   
 public:
   Value operator[](Key e) const {
-    return orig_len.get(e)-(pot.get(G.target(e))-pot.get(G.source(e)));
+    return orig_len[e]-(pot[g.target(e)]-pot[g.source(e)]);
   }
   
   ReducedLengthMap(const Graph &_g,
-                   const Graph::EdgeMap &o,
-                   const Graph::NodeMap &p)
-    : G(g), orig_len(o), pot(p) {};
+                   const Graph::EdgeMap &_o,
+                   const Graph::NodeMap &_p)
+    : g(_g), orig_len(_o), pot(_p) {};
 };
 \endcode