COIN-OR::LEMON - Graph Library

Changeset 318:1e2d6ca80793 in lemon


Ignore:
Timestamp:
10/09/08 22:41:29 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Children:
319:5e12d7734036, 330:d3a7603026a2
Phase:
public
Message:

Doc improvements

Files:
4 edited

Legend:

Unmodified
Added
Removed
  • INSTALL

    r245 r318  
    22=========================
    33
    4    Since you are reading this I assume you already obtained one of the release
     4Since you are reading this I assume you already obtained one of the release
    55tarballs and successfully extracted it. The latest version of LEMON is
    66available at our web page (http://lemon.cs.elte.hu/).
    77
    8    In order to install LEMON from the extracted source tarball you have to
     8In order to install LEMON from the extracted source tarball you have to
    99issue the following commands:
    1010
     
    2222
    2323      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.
    2626
    2727   4. `make check'
     
    5050===============================
    5151
    52    In step 2 you can customize the actions of configure by setting variables
     52In step 2 you can customize the actions of configure by setting variables
    5353and passing options to it. This can be done like this:
    5454`./configure [OPTION]... [VARIABLE=VALUE]...'
    5555
    56    Below you will find some useful variables and options (see
    57 `./configure --help' for more):
     56Below you will find some useful variables and options (see `./configure --help'
     57for more):
    5858
    5959CXX='comp'
     
    7777
    7878   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).
    8779
    8880--enable-tools
  • README

    r310 r318  
    3636test/
    3737
    38    Contains programs to check the integrity and correctness of LEMON.
     38   Programs to check the integrity and correctness of LEMON.
    3939
    4040tools/
  • doc/dirs.dox

    r209 r318  
    1919/**
    2020\dir demo
    21 \brief A collection of demo application.
     21\brief A collection of demo applications.
    2222
    23 This directory contains several simple demo application, mainly
     23This directory contains several simple demo applications, mainly
    2424for educational purposes.
    2525*/
     
    2929\brief Auxiliary (and the whole generated) documentation.
    3030
    31 Auxiliary (and the whole generated) documentation.
     31This directory contains some auxiliary pages and the whole generated
     32documentation.
    3233*/
    3334
     
    4243/**
    4344\dir tools
    44 \brief Some useful executables
     45\brief Some useful executables.
    4546
    4647This directory contains the sources of some useful complete executables.
    47 
    4848*/
    49 
    50 
    5149
    5250/**
    5351\dir lemon
    54 \brief Base include directory of LEMON
     52\brief Base include directory of LEMON.
    5553
    56 This is the base directory of lemon includes, so each include file must be
     54This is the base directory of LEMON includes, so each include file must be
    5755prefixed with this, e.g.
    5856\code
     
    6462/**
    6563\dir concepts
    66 \brief Concept descriptors and checking classes
     64\brief Concept descriptors and checking classes.
    6765
    68 This directory contains the concept descriptors and concept checkers. As a user
    69 you typically don't have to deal with these files.
     66This directory contains the concept descriptors and concept checking tools.
     67For more information see the \ref concept "Concepts" module.
    7068*/
    7169
    7270/**
    7371\dir bits
    74 \brief Implementation helper files
     72\brief Auxiliary tools for implementation.
    7573
    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.
     74This directory contains some auxiliary classes for implementing graphs,
     75maps and some other classes.
     76As a user you typically don't have to deal with these files.
    7977*/
  • doc/groups.dox

    r314 r318  
    166166@defgroup paths Path Structures
    167167@ingroup datas
    168 \brief Path structures implemented in LEMON.
     168\brief %Path structures implemented in LEMON.
    169169
    170170This group describes the path structures implemented in LEMON.
     
    491491The purpose of the classes in this group is fourfold.
    492492
    493 - These classes contain the documentations of the concepts. In order
     493- These classes contain the documentations of the %concepts. In order
    494494  to avoid document multiplications, an implementation of a concept
    495495  simply refers to the corresponding concept class.
    496496
    497497- 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
    499499  without implementations and real data structures behind the
    500500  interface. On the other hand they should provide nothing else. All
Note: See TracChangeset for help on using the changeset viewer.