Changeset 318:1e2d6ca80793 in lemon-main

Timestamp:

10/09/08 22:41:29 (16 years ago)

Author:

Peter Kovacs <kpeter@…>

Branch:

default

Phase:

public

Message:

Doc improvements

Files:

• INSTALL (modified) (4 diffs)
• README (modified) (1 diff)
• doc/dirs.dox (modified) (4 diffs)
• doc/groups.dox (modified) (2 diffs)

INSTALL

@@ -2 +2 @@
 =========================
 
-   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:
 
@@ -22 +22 @@
 
       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'
@@ -50 +50 @@
 ===============================
 
-   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'
@@ -77 +77 @@
 
    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

README

@@ -36 +36 @@
 test/
 
-   Contains programs to check the integrity and correctness of LEMON.
+   Programs to check the integrity and correctness of LEMON.
 
 tools/

doc/dirs.dox

@@ -19 +19 @@
 /**
 \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.
 */
@@ -29 +29 @@
 \brief Auxiliary (and the whole generated) documentation.
 
-Auxiliary (and the whole generated) documentation.
+This directory contains some auxiliary pages and the whole generated
+documentation.
 */
 
@@ -42 +43 @@
 /**
 \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
@@ -64 +62 @@
 /**
 \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.
 */

doc/groups.dox

@@ -166 +166 @@
 @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.
@@ -491 +491 @@
 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