# HG changeset patch
# User Peter Kovacs <kpeter@inf.elte.hu>
# Date 1223584889 -7200
# Node ID 1e2d6ca807934dd9ca4f87b55e7a542a3cff4143
# Parent a0ab96ad65fee4bffb5ba959f9f4a0ff2433abdf
Doc improvements
diff --git a/INSTALL b/INSTALL
a
|
b
|
|
1 | 1 | Installation Instructions |
2 | 2 | ========================= |
3 | 3 | |
4 | | Since you are reading this I assume you already obtained one of the release |
| 4 | Since you are reading this I assume you already obtained one of the release |
5 | 5 | tarballs and successfully extracted it. The latest version of LEMON is |
6 | 6 | available at our web page (http://lemon.cs.elte.hu/). |
7 | 7 | |
8 | | In order to install LEMON from the extracted source tarball you have to |
| 8 | In order to install LEMON from the extracted source tarball you have to |
9 | 9 | issue the following commands: |
10 | 10 | |
11 | 11 | 1. `cd lemon-x.y.z' |
… |
… |
|
21 | 21 | 3. `make' |
22 | 22 | |
23 | 23 | This command compiles the non-template part of LEMON into libemon.a |
24 | | file. It also compiles the programs in the tools, benchmark and demo |
25 | | subdirectories when enabled. |
| 24 | file. It also compiles the programs in the tools and demo subdirectories |
| 25 | when enabled. |
26 | 26 | |
27 | 27 | 4. `make check' |
28 | 28 | |
… |
… |
|
49 | 49 | Configure Options and Variables |
50 | 50 | =============================== |
51 | 51 | |
52 | | In step 2 you can customize the actions of configure by setting variables |
| 52 | In step 2 you can customize the actions of configure by setting variables |
53 | 53 | and passing options to it. This can be done like this: |
54 | 54 | `./configure [OPTION]... [VARIABLE=VALUE]...' |
55 | 55 | |
56 | | Below you will find some useful variables and options (see |
57 | | `./configure --help' for more): |
| 56 | Below you will find some useful variables and options (see `./configure --help' |
| 57 | for more): |
58 | 58 | |
59 | 59 | CXX='comp' |
60 | 60 | |
… |
… |
|
76 | 76 | --disable-demo |
77 | 77 | |
78 | 78 | Do not build the examples in the demo subdirectory (default). |
79 | | |
80 | | --enable-benchmark |
81 | | |
82 | | Build the programs in the benchmark subdirectory. |
83 | | |
84 | | --disable-benchmark |
85 | | |
86 | | Do not build the programs in the benchmark subdirectory (default). |
87 | 79 | |
88 | 80 | --enable-tools |
89 | 81 | |
diff --git a/README b/README
a
|
b
|
|
35 | 35 | |
36 | 36 | test/ |
37 | 37 | |
38 | | Contains programs to check the integrity and correctness of LEMON. |
| 38 | Programs to check the integrity and correctness of LEMON. |
39 | 39 | |
40 | 40 | tools/ |
41 | 41 | |
diff --git a/doc/dirs.dox b/doc/dirs.dox
a
|
b
|
|
18 | 18 | |
19 | 19 | /** |
20 | 20 | \dir demo |
21 | | \brief A collection of demo application. |
| 21 | \brief A collection of demo applications. |
22 | 22 | |
23 | | This directory contains several simple demo application, mainly |
| 23 | This directory contains several simple demo applications, mainly |
24 | 24 | for educational purposes. |
25 | 25 | */ |
26 | 26 | |
… |
… |
|
28 | 28 | \dir doc |
29 | 29 | \brief Auxiliary (and the whole generated) documentation. |
30 | 30 | |
31 | | Auxiliary (and the whole generated) documentation. |
| 31 | This directory contains some auxiliary pages and the whole generated |
| 32 | documentation. |
32 | 33 | */ |
33 | 34 | |
34 | 35 | /** |
… |
… |
|
41 | 42 | |
42 | 43 | /** |
43 | 44 | \dir tools |
44 | | \brief Some useful executables |
| 45 | \brief Some useful executables. |
45 | 46 | |
46 | 47 | This directory contains the sources of some useful complete executables. |
47 | | |
48 | 48 | */ |
49 | | |
50 | | |
51 | 49 | |
52 | 50 | /** |
53 | 51 | \dir lemon |
54 | | \brief Base include directory of LEMON |
| 52 | \brief Base include directory of LEMON. |
55 | 53 | |
56 | | This is the base directory of lemon includes, so each include file must be |
| 54 | This is the base directory of LEMON includes, so each include file must be |
57 | 55 | prefixed with this, e.g. |
58 | 56 | \code |
59 | 57 | #include<lemon/list_graph.h> |
… |
… |
|
63 | 61 | |
64 | 62 | /** |
65 | 63 | \dir concepts |
66 | | \brief Concept descriptors and checking classes |
| 64 | \brief Concept descriptors and checking classes. |
67 | 65 | |
68 | | This directory contains the concept descriptors and concept checkers. As a user |
69 | | you typically don't have to deal with these files. |
| 66 | This directory contains the concept descriptors and concept checking tools. |
| 67 | For more information see the \ref concept "Concepts" module. |
70 | 68 | */ |
71 | 69 | |
72 | 70 | /** |
73 | 71 | \dir bits |
74 | | \brief Implementation helper files |
| 72 | \brief Auxiliary tools for implementation. |
75 | 73 | |
76 | | This directory contains some helper classes to implement graphs, maps and |
77 | | some other classes. As a user you typically don't have to deal with these |
78 | | files. |
| 74 | This directory contains some auxiliary classes for implementing graphs, |
| 75 | maps and some other classes. |
| 76 | As a user you typically don't have to deal with these files. |
79 | 77 | */ |
diff --git a/doc/groups.dox b/doc/groups.dox
a
|
b
|
|
165 | 165 | /** |
166 | 166 | @defgroup paths Path Structures |
167 | 167 | @ingroup datas |
168 | | \brief Path structures implemented in LEMON. |
| 168 | \brief %Path structures implemented in LEMON. |
169 | 169 | |
170 | 170 | This group describes the path structures implemented in LEMON. |
171 | 171 | |
… |
… |
|
490 | 490 | |
491 | 491 | The purpose of the classes in this group is fourfold. |
492 | 492 | |
493 | | - These classes contain the documentations of the concepts. In order |
| 493 | - These classes contain the documentations of the %concepts. In order |
494 | 494 | to avoid document multiplications, an implementation of a concept |
495 | 495 | simply refers to the corresponding concept class. |
496 | 496 | |
497 | 497 | - These classes declare every functions, <tt>typedef</tt>s etc. an |
498 | | implementation of the concepts should provide, however completely |
| 498 | implementation of the %concepts should provide, however completely |
499 | 499 | without implementations and real data structures behind the |
500 | 500 | interface. On the other hand they should provide nothing else. All |
501 | 501 | the algorithms working on a data structure meeting a certain concept |