gravatar
kpeter (Peter Kovacs)
kpeter@inf.elte.hu
Doc improvements
0 4 0
default
4 files changed with 25 insertions and 35 deletions:
↑ Collapse diff ↑
Ignore white space 4 line context
... ...
@@ -2,9 +2,9 @@
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

	
... ...
@@ -22,6 +22,6 @@
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'
... ...
@@ -50,10 +50,10 @@
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'
... ...
@@ -78,12 +78,4 @@
78 78
   Do not build the examples in the demo subdirectory (default).
79 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

	
88 80
--enable-tools
89 81

	
Ignore white space 4 line context
... ...
@@ -36,5 +36,5 @@
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/
Ignore white space 4 line context
... ...
@@ -19,7 +19,7 @@
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
*/
... ...
@@ -29,5 +29,6 @@
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

	
... ...
@@ -42,17 +43,14 @@
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 49

	
50

	
51

	
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
... ...
@@ -64,16 +62,16 @@
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
*/
Ignore white space 4 line context
... ...
@@ -166,5 +166,5 @@
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.
... ...
@@ -491,10 +491,10 @@
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
0 comments (0 inline)