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

Timestamp:

01/05/07 11:59:18 (17 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:

• graph_reader.h (modified) (1 diff)
• lemon_reader.h (modified) (1 diff)

lemon/graph_reader.h

@@ -40 +40 @@
   /// description of  \ref graph-io-page "Graph Input-Output".
   ///
-  /// The file to be read may contain several maps and labeled nodes or 
-  /// edges.
+  /// The file to be read may contain several maps and labeled
+  /// (designated) nodes or edges.
   ///
   /// If you read a graph you need not read all the maps and items just those

lemon/lemon_reader.h

@@ -464 +464 @@
   /// to read a section oriented format.
   ///
-  /// In the Lemon Format each section starts with a line contains a \c \@
-  /// character on the first not white space position. This line is the
-  /// header line of the section. Each next lines belong to this section
-  /// while it does not starts with \c \@ character. This line can start a 
-  /// new section or if it can close the file with the \c \@end line.
-  /// The file format ignore the empty and comment lines. The line is
-  /// comment line if it starts with a \c # character. 
+  /// In the Lemon Format each section starts with a line containing a
+  /// \c \@ character on the first not white space position. This line
+  /// is the header line of the section. Each of the next lines belong
+  /// to this section until a line starting with \c \@ character is
+  /// found. This line can start a new section or it can close the
+  /// file with the \c \@end line.  The file format ignores the empty
+  /// and comment lines. The line is comment line if it starts with a
+  /// \c # character.
   ///
   /// The framework provides an abstract LemonReader::SectionReader class
-  /// what defines the interface of a SectionReader. The SectionReader
-  /// has the \c header() member function what get a header line string and
-  /// decides if it want to process the next section. Several SectionReaders
-  /// can be attached to an LemonReader and the first attached what can
-  /// process the section will be used. Its \c read() member will called
-  /// with a stream contains the section. From this stream the empty and
+  /// that defines the interface of a SectionReader. The SectionReader
+  /// has the \c header() member function that gets a header line string and
+  /// decides if it wants to process the next section. Several SectionReaders
+  /// can be attached to a LemonReader and the first attached that can
+  /// process the section will be used. Its \c read() member will be called
+  /// with a stream containing the section. From this stream the empty and
   /// comment lines are filtered out.
   ///