Changeset 2408:467ca6d16556 in lemon-0.x for doc

Timestamp:

03/13/07 16:42:06 (17 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

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

Message:

Doc improvements contributed by Peter Kovacs.

Location:

doc

Files:

• algorithms.dox (modified) (3 diffs)
• getting_started.dox (modified) (1 diff)
• maps1.dox (modified) (2 diffs)
• maps2.dox (modified) (2 diffs)

doc/algorithms.dox

@@ -29 +29 @@
 \subsection Bfs
 The algorithm is implemented in the \ref lemon::Bfs "Bfs" template class - rather than as function.
-The class has two template parameters: \b GR and \TR.<br>
+The class has two template parameters: \b GR and \b TR.<br>
 GR is the graph the algorithm runs on. It has \ref lemon::ListGraph "ListGraph" as default type.
 TR is a Traits class commonly used to easy the parametrization of templates. In most cases you
@@ -52 +52 @@
 Now the distances and path information are stored in maps which you can access with
 member functions like \ref lemon::Bfs::distMap "distMap()" or \ref lemon::Bfs::predMap "predMap()".<br>
-Or more directly whit other member functions like \c predNode(). Once the algorithm
+Or more directly with other member functions like \ref lemon::Bfs::predNode "predNode()". Once the algorithm
 is finished (or to be precise reached that node) \ref lemon::Bfs::dist "dist()" or \ref lemon::Bfs::predNode
 "predNode()" can be called.
@@ -116 +116 @@
 \until };
 The class meets the \ref lemon::WriteMap "WriteMap" concept. In it's \c set() method the only thing
-we need to do is insert the key - that is the node who's processing just finished - into the beginning
+we need to do is insert the key - that is the node whose processing just finished - into the beginning
 of the list.<br>
 Although we implemented this needed helper class ourselves it was not necessary.

doc/getting_started.dox

@@ -77 +77 @@
 In the next few lines we add some more nodes and edges and to the graph we need.
 Those lines are not very interesting so we skip them, but you find the whole
-working program in file hello_lemon.cc in the demo section.
+working program in file hello_world.cc in the demo section.
 
 The next statement must be familiar. But what is that INVALID in the \c while

doc/maps1.dox

@@ -35 +35 @@
 To make easy to use them - especially as template parameters - there are <i>map concepts</i> like by graph classes.
 <ul>
-<li>\ref ReadMap - values can be red out with the \c operator[].
+<li>\ref ReadMap - values can be read out with the \c operator[].
 \code value_typed_variable = map_instance[key_value]; \endcode
 </li>
@@ -60 +60 @@
 type. As an example, think of a edge-weighted directed graph.
 \code ListGraph::EdgeMap<int>  weight(graph); \endcode
-You can see that the map needs the graph hows edges will mapped, but nothing more.
+You can see that the map needs the graph whose edges will mapped, but nothing more.
 
 If the graph class is extendable or erasable the map will automatically follow

doc/maps2.dox

@@ -43 +43 @@
   typedef double Value;
   typedef Graph::Edge Key;
-  double operator[](Key e) const { return M_PI;}
+  double operator[](const Key &e) const { return M_PI;}
 };
 \endcode
@@ -52 +52 @@
 struct MyMap : public MapBase<Graph::Edge,double>
 {
-  Value operator[](Key e) const { return M_PI;}
+  Value operator[](const Key& e) const { return M_PI;}
 };
 \endcode