[Lemon-commits] Peter Kovacs: Doc improvements

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/1e2d6ca80793
changeset: 318:1e2d6ca80793
user:      Peter Kovacs <kpeter [at] inf.elte.hu>
date:      Thu Oct 09 22:41:29 2008 +0200
description:
	Doc improvements

diffstat:

4 files changed, 25 insertions(+), 35 deletions(-)
INSTALL        |   22 +++++++---------------
README         |    2 +-
doc/dirs.dox   |   30 ++++++++++++++----------------
doc/groups.dox |    6 +++---

diffs (171 lines):

diff -r a0ab96ad65fe -r 1e2d6ca80793 INSTALL
--- a/INSTALL	Thu Oct 09 16:20:37 2008 +0100
+++ b/INSTALL	Thu Oct 09 22:41:29 2008 +0200
@@ -1,11 +1,11 @@
 Installation Instructions
 =========================
 
-   Since you are reading this I assume you already obtained one of the release
+Since you are reading this I assume you already obtained one of the release
 tarballs and successfully extracted it. The latest version of LEMON is
 available at our web page (http://lemon.cs.elte.hu/).
 
-   In order to install LEMON from the extracted source tarball you have to
+In order to install LEMON from the extracted source tarball you have to
 issue the following commands:
 
    1. `cd lemon-x.y.z'
@@ -21,8 +21,8 @@
    3. `make'
 
       This command compiles the non-template part of LEMON into libemon.a
-      file. It also compiles the programs in the tools, benchmark and demo
-      subdirectories when enabled.
+      file. It also compiles the programs in the tools and demo subdirectories
+      when enabled.
 
    4. `make check'
 
@@ -49,12 +49,12 @@
 Configure Options and Variables
 ===============================
 
-   In step 2 you can customize the actions of configure by setting variables
+In step 2 you can customize the actions of configure by setting variables
 and passing options to it. This can be done like this:
 `./configure [OPTION]... [VARIABLE=VALUE]...'
 
-   Below you will find some useful variables and options (see
-`./configure --help' for more):
+Below you will find some useful variables and options (see `./configure --help'
+for more):
 
 CXX='comp'
 
@@ -76,14 +76,6 @@
 --disable-demo
 
    Do not build the examples in the demo subdirectory (default).
-
---enable-benchmark
-
-   Build the programs in the benchmark subdirectory.
-
---disable-benchmark
-
-   Do not build the programs in the benchmark subdirectory (default).
 
 --enable-tools
 
diff -r a0ab96ad65fe -r 1e2d6ca80793 README
--- a/README	Thu Oct 09 16:20:37 2008 +0100
+++ b/README	Thu Oct 09 22:41:29 2008 +0200
@@ -35,7 +35,7 @@
 
 test/
 
-   Contains programs to check the integrity and correctness of LEMON.
+   Programs to check the integrity and correctness of LEMON.
 
 tools/
 
diff -r a0ab96ad65fe -r 1e2d6ca80793 doc/dirs.dox
--- a/doc/dirs.dox	Thu Oct 09 16:20:37 2008 +0100
+++ b/doc/dirs.dox	Thu Oct 09 22:41:29 2008 +0200
@@ -18,9 +18,9 @@
 
 /**
 \dir demo
-\brief A collection of demo application.
+\brief A collection of demo applications.
 
-This directory contains several simple demo application, mainly
+This directory contains several simple demo applications, mainly
 for educational purposes.
 */
 
@@ -28,7 +28,8 @@
 \dir doc
 \brief Auxiliary (and the whole generated) documentation.
 
-Auxiliary (and the whole generated) documentation.
+This directory contains some auxiliary pages and the whole generated
+documentation.
 */
 
 /**
@@ -41,19 +42,16 @@
 
 /**
 \dir tools
-\brief Some useful executables
+\brief Some useful executables.
 
 This directory contains the sources of some useful complete executables.
-
 */
-
-
 
 /**
 \dir lemon
-\brief Base include directory of LEMON
+\brief Base include directory of LEMON.
 
-This is the base directory of lemon includes, so each include file must be
+This is the base directory of LEMON includes, so each include file must be
 prefixed with this, e.g.
 \code
 #include<lemon/list_graph.h>
@@ -63,17 +61,17 @@
 
 /**
 \dir concepts
-\brief Concept descriptors and checking classes
+\brief Concept descriptors and checking classes.
 
-This directory contains the concept descriptors and concept checkers. As a user
-you typically don't have to deal with these files.
+This directory contains the concept descriptors and concept checking tools.
+For more information see the \ref concept "Concepts" module.
 */
 
 /**
 \dir bits
-\brief Implementation helper files
+\brief Auxiliary tools for implementation.
 
-This directory contains some helper classes to implement graphs, maps and
-some other classes. As a user you typically don't have to deal with these
-files.
+This directory contains some auxiliary classes for implementing graphs, 
+maps and some other classes.
+As a user you typically don't have to deal with these files.
 */
diff -r a0ab96ad65fe -r 1e2d6ca80793 doc/groups.dox
--- a/doc/groups.dox	Thu Oct 09 16:20:37 2008 +0100
+++ b/doc/groups.dox	Thu Oct 09 22:41:29 2008 +0200
@@ -165,7 +165,7 @@
 /**
 @defgroup paths Path Structures
 @ingroup datas
-\brief Path structures implemented in LEMON.
+\brief %Path structures implemented in LEMON.
 
 This group describes the path structures implemented in LEMON.
 
@@ -490,12 +490,12 @@
 
 The purpose of the classes in this group is fourfold.
 
-- These classes contain the documentations of the concepts. In order
+- These classes contain the documentations of the %concepts. In order
   to avoid document multiplications, an implementation of a concept
   simply refers to the corresponding concept class.
 
 - These classes declare every functions, <tt>typedef</tt>s etc. an
-  implementation of the concepts should provide, however completely
+  implementation of the %concepts should provide, however completely
   without implementations and real data structures behind the
   interface. On the other hand they should provide nothing else. All
   the algorithms working on a data structure meeting a certain concept