[Lemon-commits] Peter Kovacs: Various small fixes

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon-tutorial/rev/18404ec968ca
changeset: 57:18404ec968ca
user:      Peter Kovacs <kpeter [at] inf.elte.hu>
date:      Mon Mar 01 02:28:44 2010 +0100
description:
	Various small fixes

diffstat:

 adaptors.dox        |   4 ++--
 algorithms.dox      |  12 +++++++-----
 getting_started.dox |   2 +-
 intro.dox           |   2 +-
 lp.dox              |   4 ++--
 maps.dox            |   4 +++-
 tools.dox           |   7 +++++--
 undir_graphs.dox    |   4 ++--
 8 files changed, 23 insertions(+), 16 deletions(-)

diffs (157 lines):

diff --git a/adaptors.dox b/adaptors.dox
--- a/adaptors.dox
+++ b/adaptors.dox
@@ -25,7 +25,7 @@
 has to be considered.
 If some nodes or arcs have to be hidden (maybe temporarily) or the reverse
 oriented graph has to be used, then this is the case.
-However, actually modifing physical storage of the graph or
+However, actually modifying physical storage of the graph or
 making a copy of the graph structure along with the required maps
 could be rather expensive (in time or in memory usage) compared to the
 operations that should be performed on the altered graph.
@@ -61,7 +61,7 @@
 code, and makes it possible to easily implement complex algorithms based on
 well tested standard components.
 
-For solving the problem introduced above, we could use the follwing code.
+For solving the problem introduced above, we could use the following code.
 
 \code
   ListDigraph g;
diff --git a/algorithms.dox b/algorithms.dox
--- a/algorithms.dox
+++ b/algorithms.dox
@@ -22,9 +22,14 @@
 
 \todo This page is under construction.
 
+\todo The following contents are mainly ported from the LEMON 0.x tutorial,
+thus they have to be thoroughly revised and reworked.
+
+\warning Currently, this section may contain old or faulty contents.
+
 In addition to the graph structures, the most important parts of LEMON are
 the various algorithms related to graph theory and combinatorial optimization.
-The library probvides quite flexible and efficient implementations
+The library provides quite flexible and efficient implementations
 for well-known fundamental algorithms, such as breadth-first
 search (BFS), depth-first search (DFS), Dijkstra algorithm, Kruskal algorithm
 and methods for discovering graph properties like connectivity, bipartiteness
@@ -37,9 +42,6 @@
 
 [SEC]sec_graph_search[SEC] Graph Search
 
-\todo The following contents are ported from the LEMON 0.x tutorial,
-thus they have to thouroughly revised, reorganized and reworked.
-
 See \ref Bfs, \ref Dfs and \ref graph_properties.
 
 Both \ref lemon::Bfs "Bfs" and \ref lemon::Dfs "Dfs" are highly adaptable and efficient
@@ -50,7 +52,7 @@
 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 \b TR.<br>
 GR is the digraph the algorithm runs on. It has \ref lemon::ListDigraph "ListDigraph" as default type.
-TR is a Traits class commonly used to easy the parametrization of templates. In most cases you
+TR is a Traits class commonly used to easy the parameterization of templates. In most cases you
 wont need to modify the default type \ref lemon::BfsDefaultTraits "BfsDefaultTraits<GR>".
 
 To use the class, declare it!
diff --git a/getting_started.dox b/getting_started.dox
--- a/getting_started.dox
+++ b/getting_started.dox
@@ -49,7 +49,7 @@
 g++ -o hello_lemon hello_lemon.cc -lemon
 \endverbatim
 
-As a result you will get the exacutable \c hello_lemon in the current
+As a result you will get the executable \c hello_lemon in the current
 directory, which you can run by the following command.
 
 \verbatim
diff --git a/intro.dox b/intro.dox
--- a/intro.dox
+++ b/intro.dox
@@ -36,7 +36,7 @@
 which often arise when designing and testing certain networks,
 for example in telecommunication, computer networks, logistics, scheduling,
 and other areas.
-A very natural way of modelling these networks is by means of a graph.
+A very natural way of modeling these networks is by means of a graph.
 Generally, if you want to write any program that works with graphs,
 then you might find it useful and convenient to use LEMON.
 
diff --git a/lp.dox b/lp.dox
--- a/lp.dox
+++ b/lp.dox
@@ -194,9 +194,9 @@
   x2 = 9
 \endcode
 
-The documnetation of the MIP solver interface can be found in the
+The documentation of the MIP solver interface can be found in the
 reference manual at the class \ref MipSolver. The common parts of the
-LP and MIP interfaces are docmented in their common ancestor class
+LP and MIP interfaces are documented in their common ancestor class
 \ref LpBase.
 
 
diff --git a/maps.dox b/maps.dox
--- a/maps.dox
+++ b/maps.dox
@@ -23,7 +23,9 @@
 \todo This page is under construction.
 
 \todo The following contents are ported from the LEMON 0.x tutorial,
-thus they have to thouroughly revised, reorganized and reworked.
+thus they have to be thoroughly revised and reworked.
+
+\warning Currently, this section may contain old or faulty contents.
 
 The LEMON maps are not only just storage classes, but also
 they are %concepts of any key--value based data access.
diff --git a/tools.dox b/tools.dox
--- a/tools.dox
+++ b/tools.dox
@@ -43,8 +43,8 @@
 Another nice feature of the library is \ref graphToEps(), a highly
 configurable graph displaying tool (using EPS output format).
 Originally, it was developed to evaluate the flexibility and scalability
-of LEMON's approach to implement named parameters. Later it
-has been evolved into a versatile tool featuring above 35 named
+of LEMON's approach to implement \ref named-param "named parameters".
+Later it has been evolved into a versatile tool featuring above 35 named
 parameters. The following code demonstrates its typical use.
 
 \code
@@ -67,6 +67,9 @@
 
 \image html graph_to_eps.png
 
+For more examples, see \ref graph_to_eps_demo.cc in the demo directory
+of the LEMON source.
+
 
 [SEC]sec_time_count[SEC] Time Measuring and Counting
 
diff --git a/undir_graphs.dox b/undir_graphs.dox
--- a/undir_graphs.dox
+++ b/undir_graphs.dox
@@ -55,7 +55,7 @@
 
 Each edge has an inherent orientation, thus it can be defined whether
 an arc is forward or backward oriented in an undirected graph with respect
-to this default oriantation of the represented edge.
+to this default orientation of the represented edge.
 The direction of an arc can be obtained and set using the functions
 \ref concepts::Graph::direction() "direction()" and
 \ref concepts::Graph::direct() "direct()", respectively.
@@ -129,7 +129,7 @@
 \endcode
 
 
-[SEC]sec_undir_graph_algs[SEC] Undirected Graph Algorihtms
+[SEC]sec_undir_graph_algs[SEC] Undirected Graph Algorithms
 
 \todo This subsection is under construction.