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

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.

File:

• doc/algorithms.dox (modified) (3 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.