97 /// In the Lemon Format each section starts with a line contains a \c \@ |
97 /// In the Lemon Format each section starts with a line contains a \c \@ |
98 /// character on the first not white space position. This line is the |
98 /// character on the first not white space position. This line is the |
99 /// header line of the section. Each next lines belong to this section |
99 /// header line of the section. Each next lines belong to this section |
100 /// while it does not starts with \c \@ character. This line can start a |
100 /// while it does not starts with \c \@ character. This line can start a |
101 /// new section or if it can close the file with the \c \@end line. |
101 /// new section or if it can close the file with the \c \@end line. |
102 /// The file format ignore the empty lines and it may contain comments |
102 /// The file format ignore the empty and comment lines. The line is |
103 /// started with a \c # character to the end of the line. |
103 /// comment line if it starts with a \c # character. |
104 /// |
104 /// |
105 /// The framework provides an abstract LemonReader::SectionReader class |
105 /// The framework provides an abstract LemonReader::SectionReader class |
106 /// what defines the interface of a SectionReader. The SectionReader |
106 /// what defines the interface of a SectionReader. The SectionReader |
107 /// has the \c header() member function what get a header line string and |
107 /// has the \c header() member function what get a header line string and |
108 /// decides if it want to process the next section. Several SectionReaders |
108 /// decides if it want to process the next section. Several SectionReaders |
109 /// can be attached to an LemonReader and the first attached what can |
109 /// can be attached to an LemonReader and the first attached what can |
110 /// process the section will be used. Its \c read() member will called |
110 /// process the section will be used. Its \c read() member will called |
111 /// with a stream contains the section. From this stream the empty lines |
111 /// with a stream contains the section. From this stream the empty and |
112 /// and comments are filtered out. |
112 /// comment lines are filtered out. |
113 /// |
113 /// |
114 /// \relates GraphReader |
114 /// \relates GraphReader |
115 /// \relates NodeSetReader |
115 /// \relates NodeSetReader |
116 /// \relates EdgeSetReader |
116 /// \relates EdgeSetReader |
117 /// \relates NodesReader |
117 /// \relates NodesReader |