I only corrected some errors in the documentation.
authorathos
Fri, 05 Jan 2007 10:59:18 +0000
changeset 2334c1e936e6a46b
parent 2333 8070a099ffb6
child 2335 27aa03cd3121
I only corrected some errors in the documentation.
lemon/graph_reader.h
lemon/lemon_reader.h
     1.1 --- a/lemon/graph_reader.h	Tue Dec 19 15:53:42 2006 +0000
     1.2 +++ b/lemon/graph_reader.h	Fri Jan 05 10:59:18 2007 +0000
     1.3 @@ -39,8 +39,8 @@
     1.4    /// Before you read this documentation it might be useful to read the general
     1.5    /// description of  \ref graph-io-page "Graph Input-Output".
     1.6    ///
     1.7 -  /// The file to be read may contain several maps and labeled nodes or 
     1.8 -  /// edges.
     1.9 +  /// The file to be read may contain several maps and labeled
    1.10 +  /// (designated) nodes or edges.
    1.11    ///
    1.12    /// If you read a graph you need not read all the maps and items just those
    1.13    /// that you need. The interface of the \c GraphReader is very similar to
     2.1 --- a/lemon/lemon_reader.h	Tue Dec 19 15:53:42 2006 +0000
     2.2 +++ b/lemon/lemon_reader.h	Fri Jan 05 10:59:18 2007 +0000
     2.3 @@ -463,21 +463,22 @@
     2.4    /// determine what sections are in a lemon file we give only a framework
     2.5    /// to read a section oriented format.
     2.6    ///
     2.7 -  /// In the Lemon Format each section starts with a line contains a \c \@
     2.8 -  /// character on the first not white space position. This line is the
     2.9 -  /// header line of the section. Each next lines belong to this section
    2.10 -  /// while it does not starts with \c \@ character. This line can start a 
    2.11 -  /// new section or if it can close the file with the \c \@end line.
    2.12 -  /// The file format ignore the empty and comment lines. The line is
    2.13 -  /// comment line if it starts with a \c # character. 
    2.14 +  /// In the Lemon Format each section starts with a line containing a
    2.15 +  /// \c \@ character on the first not white space position. This line
    2.16 +  /// is the header line of the section. Each of the next lines belong
    2.17 +  /// to this section until a line starting with \c \@ character is
    2.18 +  /// found. This line can start a new section or it can close the
    2.19 +  /// file with the \c \@end line.  The file format ignores the empty
    2.20 +  /// and comment lines. The line is comment line if it starts with a
    2.21 +  /// \c # character.
    2.22    ///
    2.23    /// The framework provides an abstract LemonReader::SectionReader class
    2.24 -  /// what defines the interface of a SectionReader. The SectionReader
    2.25 -  /// has the \c header() member function what get a header line string and
    2.26 -  /// decides if it want to process the next section. Several SectionReaders
    2.27 -  /// can be attached to an LemonReader and the first attached what can
    2.28 -  /// process the section will be used. Its \c read() member will called
    2.29 -  /// with a stream contains the section. From this stream the empty and
    2.30 +  /// that defines the interface of a SectionReader. The SectionReader
    2.31 +  /// has the \c header() member function that gets a header line string and
    2.32 +  /// decides if it wants to process the next section. Several SectionReaders
    2.33 +  /// can be attached to a LemonReader and the first attached that can
    2.34 +  /// process the section will be used. Its \c read() member will be called
    2.35 +  /// with a stream containing the section. From this stream the empty and
    2.36    /// comment lines are filtered out.
    2.37    ///
    2.38    /// \relates GraphReader