Changeset 181:e34570db81ea in lemon-main

Timestamp:

06/18/08 14:07:18 (16 years ago)

Author:

Alpar Juttner <alpar@…>

Branch:

default

Phase:

public

Message:

Doc improvements in LgfContents?

File:

• lemon/lgf_reader.h (modified) (5 diffs)

lemon/lgf_reader.h

@@ -2195 +2195 @@
     /// @}
 
-    /// \name Arc sections 
+    /// \name Arc/Edge sections 
     /// @{
 
-    /// \brief Gives back the number of arc sections in the file.
-    ///
-    /// Gives back the number of arc sections in the file.
-    /// \note It is synonim of \c edgeSectionNum().
+    /// \brief Gives back the number of arc/edge sections in the file.
+    ///
+    /// Gives back the number of arc/edge sections in the file.
+    /// \note It is synonym of \c edgeSectionNum().
     int arcSectionNum() const {
       return _edge_sections.size();
@@ -2209 +2209 @@
     ///
     /// Returns the section name at the given position. 
-    /// \note It is synonim of \c edgeSection().
+    /// \note It is synonym of \c edgeSection().
     const std::string& arcSection(int i) const {
       return _edge_sections[i];
     }
 
-    /// \brief Gives back the arc maps for the given section.
-    ///
-    /// Gives back the arc maps for the given section.
-    /// \note It is synonim of \c edgeMaps().
+    /// \brief Gives back the arc/edge maps for the given section.
+    ///
+    /// Gives back the arc/edge maps for the given section.
+    /// \note It is synonym of \c edgeMaps().
     const std::vector<std::string>& arcMaps(int i) const {
       return _edge_maps[i];
@@ -2224 +2224 @@
     /// @}
 
-    /// \name Edge sections   
+    /// \name Synonyms
     /// @{
 
-    /// \brief Gives back the number of edge sections in the file.
-    ///
-    /// Gives back the number of edge sections in the file.
+    /// \brief Gives back the number of arc/edge sections in the file.
+    ///
+    /// Gives back the number of arc/edge sections in the file.
+    /// \note It is synonym of \c arcSectionNum().
     int edgeSectionNum() const {
       return _edge_sections.size();
@@ -2237 +2238 @@
     ///
     /// Returns the section name at the given position. 
+    /// \note It is synonym of \c arcSection().
     const std::string& edgeSection(int i) const {
       return _edge_sections[i];
@@ -2244 +2246 @@
     ///
     /// Gives back the edge maps for the given section.
+    /// \note It is synonym of \c arcMaps().
     const std::vector<std::string>& edgeMaps(int i) const {
       return _edge_maps[i];