COIN-OR::LEMON - Graph Library

Changeset 2334:c1e936e6a46b in lemon-0.x for lemon


Ignore:
Timestamp:
01/05/07 11:59:18 (13 years ago)
Author:
athos
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3121
Message:

I only corrected some errors in the documentation.

Location:
lemon
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • lemon/graph_reader.h

    r2200 r2334  
    4040  /// description of  \ref graph-io-page "Graph Input-Output".
    4141  ///
    42   /// The file to be read may contain several maps and labeled nodes or
    43   /// edges.
     42  /// The file to be read may contain several maps and labeled
     43  /// (designated) nodes or edges.
    4444  ///
    4545  /// If you read a graph you need not read all the maps and items just those
  • lemon/lemon_reader.h

    r2282 r2334  
    464464  /// to read a section oriented format.
    465465  ///
    466   /// In the Lemon Format each section starts with a line contains a \c \@
    467   /// character on the first not white space position. This line is the
    468   /// header line of the section. Each next lines belong to this section
    469   /// while it does not starts with \c \@ character. This line can start a
    470   /// new section or if it can close the file with the \c \@end line.
    471   /// The file format ignore the empty and comment lines. The line is
    472   /// comment line if it starts with a \c # character.
     466  /// In the Lemon Format each section starts with a line containing a
     467  /// \c \@ character on the first not white space position. This line
     468  /// is the header line of the section. Each of the next lines belong
     469  /// to this section until a line starting with \c \@ character is
     470  /// found. This line can start a new section or it can close the
     471  /// file with the \c \@end line.  The file format ignores the empty
     472  /// and comment lines. The line is comment line if it starts with a
     473  /// \c # character.
    473474  ///
    474475  /// The framework provides an abstract LemonReader::SectionReader class
    475   /// what defines the interface of a SectionReader. The SectionReader
    476   /// has the \c header() member function what get a header line string and
    477   /// decides if it want to process the next section. Several SectionReaders
    478   /// can be attached to an LemonReader and the first attached what can
    479   /// process the section will be used. Its \c read() member will called
    480   /// with a stream contains the section. From this stream the empty and
     476  /// that defines the interface of a SectionReader. The SectionReader
     477  /// has the \c header() member function that gets a header line string and
     478  /// decides if it wants to process the next section. Several SectionReaders
     479  /// can be attached to a LemonReader and the first attached that can
     480  /// process the section will be used. Its \c read() member will be called
     481  /// with a stream containing the section. From this stream the empty and
    481482  /// comment lines are filtered out.
    482483  ///
Note: See TracChangeset for help on using the changeset viewer.