Some documentation modifications
authordeba
Mon, 14 Nov 2005 18:34:16 +0000
changeset 1788614ce2dd3cba
parent 1787 932b8490caf0
child 1789 96942bf94a0c
Some documentation modifications
doc/coding_style.dox
doc/graph_io.dox
doc/maps.dox
     1.1 --- a/doc/coding_style.dox	Sun Nov 13 20:01:17 2005 +0000
     1.2 +++ b/doc/coding_style.dox	Mon Nov 14 18:34:16 2005 +0000
     1.3 @@ -77,6 +77,12 @@
     1.4  ClassNameEndsWithException
     1.5  \endcode
     1.6  
     1.7 +or
     1.8 +
     1.9 +\code
    1.10 +ClassNameEndsWithError
    1.11 +\endcode
    1.12 +
    1.13  \section header-template Template Header File
    1.14  
    1.15  Each LEMON header file should look like this:
     2.1 --- a/doc/graph_io.dox	Sun Nov 13 20:01:17 2005 +0000
     2.2 +++ b/doc/graph_io.dox	Mon Nov 14 18:34:16 2005 +0000
     2.3 @@ -110,10 +110,6 @@
     2.4  
     2.5  \section use Using graph input-output
     2.6  
     2.7 -The easiest way of using graph input and output is using the versions of the
     2.8 -  public \ref readGraph() and \ref writeGraph() functions; if you don't need
     2.9 -  very sophisticated behaviour then you might be satisfied with
    2.10 -  those. Otherwise go on reading this page.
    2.11  
    2.12  The graph input and output is based on <em> reading and writing
    2.13  commands</em>. The user gives reading and writing commands to the reader or
    2.14 @@ -361,7 +357,7 @@
    2.15  the \ref lemon::UndirGraphReader "UndirGraphReader"
    2.16  and \ref lemon::UndirGraphWriter "UndirGraphWriter".
    2.17  
    2.18 -The \ref lemon::UndirGraphReader::readUndirMap() "readUndirMap()"
    2.19 +The \ref lemon::UndirGraphReader::readUndirEdgeMap() "readUndirEdgeMap()"
    2.20  function reads an undirected map and the
    2.21  \ref lemon::UndirGraphReader::readUndirEdge() "readUndirEdge()"
    2.22  reads an undirected edge from the file, 
     3.1 --- a/doc/maps.dox	Sun Nov 13 20:01:17 2005 +0000
     3.2 +++ b/doc/maps.dox	Mon Nov 14 18:34:16 2005 +0000
     3.3 @@ -27,14 +27,14 @@
     3.4  Each graph structure in LEMON provides two standard map templates called
     3.5  \c EdgeMap and \c NodeMap. Both are reference maps and you can easily
     3.6  assign data to the nodes and to the edges of the graph. For example if you
     3.7 -have a graph \c G defined as
     3.8 +have a graph \c g defined as
     3.9  \code
    3.10 -  ListGraph G;
    3.11 +  ListGraph g;
    3.12  \endcode
    3.13  and you want to assign a floating point value to each edge, you can do
    3.14  it like this.
    3.15  \code
    3.16 -  ListGraph::EdgeMap<double> length(G);
    3.17 +  ListGraph::EdgeMap<double> length(g);
    3.18  \endcode
    3.19  Note that you must give the underlying graph to the constructor.
    3.20  
    3.21 @@ -94,8 +94,6 @@
    3.22  
    3.23  An alternative way to define maps is to use \c MapBase
    3.24  
    3.25 -\todo For this, \c MapBase seems to be a better name then \c NullMap.
    3.26 -
    3.27  \code
    3.28  struct MyMap : public MapBase<Graph::Edge,double>
    3.29  {
    3.30 @@ -116,13 +114,13 @@
    3.31    
    3.32  public:
    3.33    Value operator[](Key e) const {
    3.34 -    return orig_len.get(e)-(pot.get(G.target(e))-pot.get(G.source(e)));
    3.35 +    return orig_len[e]-(pot[g.target(e)]-pot[g.source(e)]);
    3.36    }
    3.37    
    3.38    ReducedLengthMap(const Graph &_g,
    3.39 -                   const Graph::EdgeMap &o,
    3.40 -                   const Graph::NodeMap &p)
    3.41 -    : G(g), orig_len(o), pot(p) {};
    3.42 +                   const Graph::EdgeMap &_o,
    3.43 +                   const Graph::NodeMap &_p)
    3.44 +    : g(_g), orig_len(_o), pot(_p) {};
    3.45  };
    3.46  \endcode
    3.47