[Lemon-commits] Alpar Juttner: Doc improvements in LgfContents

[Lemon HG]

details:   http://lemon.cs.elte.hu/hg/lemon/rev/e34570db81ea
changeset: 181:e34570db81ea
user:      Alpar Juttner <alpar [at] cs.elte.hu>
date:      Wed Jun 18 13:07:18 2008 +0100
description:
	Doc improvements in LgfContents

diffstat:

1 file changed, 14 insertions(+), 11 deletions(-)
lemon/lgf_reader.h |   25 ++++++++++++++-----------

diffs (73 lines):

diff -r 4b9ab1324c3b -r e34570db81ea lemon/lgf_reader.h
--- a/lemon/lgf_reader.h	Wed Jun 18 12:59:07 2008 +0100
+++ b/lemon/lgf_reader.h	Wed Jun 18 13:07:18 2008 +0100
@@ -2194,13 +2194,13 @@
 
     /// @}
 
-    /// \name Arc sections 
+    /// \name Arc/Edge sections 
     /// @{
 
-    /// \brief Gives back the number of arc sections in the file.
+    /// \brief Gives back the number of arc/edge sections in the file.
     ///
-    /// Gives back the number of arc sections in the file.
-    /// \note It is synonim of \c edgeSectionNum().
+    /// 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();
     }
@@ -2208,27 +2208,28 @@
     /// \brief Returns the section name at the given position. 
     ///
     /// 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.
+    /// \brief Gives back the arc/edge maps for the given section.
     ///
-    /// Gives back the arc maps for the given section.
-    /// \note It is synonim of \c edgeMaps().
+    /// 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];
     }
 
     /// @}
 
-    /// \name Edge sections   
+    /// \name Synonyms
     /// @{
 
-    /// \brief 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 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();
     }
@@ -2236,6 +2237,7 @@
     /// \brief Returns the section name at the given position. 
     ///
     /// 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];
     }
@@ -2243,6 +2245,7 @@
     /// \brief Gives back the edge maps for the given section.
     ///
     /// 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];
     }