Doc improvements
authorPeter Kovacs <kpeter@inf.elte.hu>
Thu, 09 Oct 2008 22:41:29 +0200 (2008-10-09)
changeset 3181e2d6ca80793
parent 317 a0ab96ad65fe
child 319 5e12d7734036
Doc improvements
INSTALL
README
doc/dirs.dox
doc/groups.dox
     1.1 --- a/INSTALL	Thu Oct 09 16:20:37 2008 +0100
     1.2 +++ b/INSTALL	Thu Oct 09 22:41:29 2008 +0200
     1.3 @@ -1,11 +1,11 @@
     1.4  Installation Instructions
     1.5  =========================
     1.6  
     1.7 -   Since you are reading this I assume you already obtained one of the release
     1.8 +Since you are reading this I assume you already obtained one of the release
     1.9  tarballs and successfully extracted it. The latest version of LEMON is
    1.10  available at our web page (http://lemon.cs.elte.hu/).
    1.11  
    1.12 -   In order to install LEMON from the extracted source tarball you have to
    1.13 +In order to install LEMON from the extracted source tarball you have to
    1.14  issue the following commands:
    1.15  
    1.16     1. `cd lemon-x.y.z'
    1.17 @@ -21,8 +21,8 @@
    1.18     3. `make'
    1.19  
    1.20        This command compiles the non-template part of LEMON into libemon.a
    1.21 -      file. It also compiles the programs in the tools, benchmark and demo
    1.22 -      subdirectories when enabled.
    1.23 +      file. It also compiles the programs in the tools and demo subdirectories
    1.24 +      when enabled.
    1.25  
    1.26     4. `make check'
    1.27  
    1.28 @@ -49,12 +49,12 @@
    1.29  Configure Options and Variables
    1.30  ===============================
    1.31  
    1.32 -   In step 2 you can customize the actions of configure by setting variables
    1.33 +In step 2 you can customize the actions of configure by setting variables
    1.34  and passing options to it. This can be done like this:
    1.35  `./configure [OPTION]... [VARIABLE=VALUE]...'
    1.36  
    1.37 -   Below you will find some useful variables and options (see
    1.38 -`./configure --help' for more):
    1.39 +Below you will find some useful variables and options (see `./configure --help'
    1.40 +for more):
    1.41  
    1.42  CXX='comp'
    1.43  
    1.44 @@ -77,14 +77,6 @@
    1.45  
    1.46     Do not build the examples in the demo subdirectory (default).
    1.47  
    1.48 ---enable-benchmark
    1.49 -
    1.50 -   Build the programs in the benchmark subdirectory.
    1.51 -
    1.52 ---disable-benchmark
    1.53 -
    1.54 -   Do not build the programs in the benchmark subdirectory (default).
    1.55 -
    1.56  --enable-tools
    1.57  
    1.58     Build the programs in the tools subdirectory (default).
     2.1 --- a/README	Thu Oct 09 16:20:37 2008 +0100
     2.2 +++ b/README	Thu Oct 09 22:41:29 2008 +0200
     2.3 @@ -35,7 +35,7 @@
     2.4  
     2.5  test/
     2.6  
     2.7 -   Contains programs to check the integrity and correctness of LEMON.
     2.8 +   Programs to check the integrity and correctness of LEMON.
     2.9  
    2.10  tools/
    2.11  
     3.1 --- a/doc/dirs.dox	Thu Oct 09 16:20:37 2008 +0100
     3.2 +++ b/doc/dirs.dox	Thu Oct 09 22:41:29 2008 +0200
     3.3 @@ -18,9 +18,9 @@
     3.4  
     3.5  /**
     3.6  \dir demo
     3.7 -\brief A collection of demo application.
     3.8 +\brief A collection of demo applications.
     3.9  
    3.10 -This directory contains several simple demo application, mainly
    3.11 +This directory contains several simple demo applications, mainly
    3.12  for educational purposes.
    3.13  */
    3.14  
    3.15 @@ -28,7 +28,8 @@
    3.16  \dir doc
    3.17  \brief Auxiliary (and the whole generated) documentation.
    3.18  
    3.19 -Auxiliary (and the whole generated) documentation.
    3.20 +This directory contains some auxiliary pages and the whole generated
    3.21 +documentation.
    3.22  */
    3.23  
    3.24  /**
    3.25 @@ -41,19 +42,16 @@
    3.26  
    3.27  /**
    3.28  \dir tools
    3.29 -\brief Some useful executables
    3.30 +\brief Some useful executables.
    3.31  
    3.32  This directory contains the sources of some useful complete executables.
    3.33 -
    3.34  */
    3.35  
    3.36 -
    3.37 -
    3.38  /**
    3.39  \dir lemon
    3.40 -\brief Base include directory of LEMON
    3.41 +\brief Base include directory of LEMON.
    3.42  
    3.43 -This is the base directory of lemon includes, so each include file must be
    3.44 +This is the base directory of LEMON includes, so each include file must be
    3.45  prefixed with this, e.g.
    3.46  \code
    3.47  #include<lemon/list_graph.h>
    3.48 @@ -63,17 +61,17 @@
    3.49  
    3.50  /**
    3.51  \dir concepts
    3.52 -\brief Concept descriptors and checking classes
    3.53 +\brief Concept descriptors and checking classes.
    3.54  
    3.55 -This directory contains the concept descriptors and concept checkers. As a user
    3.56 -you typically don't have to deal with these files.
    3.57 +This directory contains the concept descriptors and concept checking tools.
    3.58 +For more information see the \ref concept "Concepts" module.
    3.59  */
    3.60  
    3.61  /**
    3.62  \dir bits
    3.63 -\brief Implementation helper files
    3.64 +\brief Auxiliary tools for implementation.
    3.65  
    3.66 -This directory contains some helper classes to implement graphs, maps and
    3.67 -some other classes. As a user you typically don't have to deal with these
    3.68 -files.
    3.69 +This directory contains some auxiliary classes for implementing graphs, 
    3.70 +maps and some other classes.
    3.71 +As a user you typically don't have to deal with these files.
    3.72  */
     4.1 --- a/doc/groups.dox	Thu Oct 09 16:20:37 2008 +0100
     4.2 +++ b/doc/groups.dox	Thu Oct 09 22:41:29 2008 +0200
     4.3 @@ -165,7 +165,7 @@
     4.4  /**
     4.5  @defgroup paths Path Structures
     4.6  @ingroup datas
     4.7 -\brief Path structures implemented in LEMON.
     4.8 +\brief %Path structures implemented in LEMON.
     4.9  
    4.10  This group describes the path structures implemented in LEMON.
    4.11  
    4.12 @@ -490,12 +490,12 @@
    4.13  
    4.14  The purpose of the classes in this group is fourfold.
    4.15  
    4.16 -- These classes contain the documentations of the concepts. In order
    4.17 +- These classes contain the documentations of the %concepts. In order
    4.18    to avoid document multiplications, an implementation of a concept
    4.19    simply refers to the corresponding concept class.
    4.20  
    4.21  - These classes declare every functions, <tt>typedef</tt>s etc. an
    4.22 -  implementation of the concepts should provide, however completely
    4.23 +  implementation of the %concepts should provide, however completely
    4.24    without implementations and real data structures behind the
    4.25    interface. On the other hand they should provide nothing else. All
    4.26    the algorithms working on a data structure meeting a certain concept