Doc improvements in LgfContents
authorAlpar Juttner <alpar@cs.elte.hu>
Wed, 18 Jun 2008 13:07:18 +0100
changeset 181e34570db81ea
parent 180 4b9ab1324c3b
child 182 9c6dfb5141d3
Doc improvements in LgfContents
lemon/lgf_reader.h
     1.1 --- a/lemon/lgf_reader.h	Wed Jun 18 12:59:07 2008 +0100
     1.2 +++ b/lemon/lgf_reader.h	Wed Jun 18 13:07:18 2008 +0100
     1.3 @@ -2194,13 +2194,13 @@
     1.4  
     1.5      /// @}
     1.6  
     1.7 -    /// \name Arc sections 
     1.8 +    /// \name Arc/Edge sections 
     1.9      /// @{
    1.10  
    1.11 -    /// \brief Gives back the number of arc sections in the file.
    1.12 +    /// \brief Gives back the number of arc/edge sections in the file.
    1.13      ///
    1.14 -    /// Gives back the number of arc sections in the file.
    1.15 -    /// \note It is synonim of \c edgeSectionNum().
    1.16 +    /// Gives back the number of arc/edge sections in the file.
    1.17 +    /// \note It is synonym of \c edgeSectionNum().
    1.18      int arcSectionNum() const {
    1.19        return _edge_sections.size();
    1.20      }
    1.21 @@ -2208,27 +2208,28 @@
    1.22      /// \brief Returns the section name at the given position. 
    1.23      ///
    1.24      /// Returns the section name at the given position. 
    1.25 -    /// \note It is synonim of \c edgeSection().
    1.26 +    /// \note It is synonym of \c edgeSection().
    1.27      const std::string& arcSection(int i) const {
    1.28        return _edge_sections[i];
    1.29      }
    1.30  
    1.31 -    /// \brief Gives back the arc maps for the given section.
    1.32 +    /// \brief Gives back the arc/edge maps for the given section.
    1.33      ///
    1.34 -    /// Gives back the arc maps for the given section.
    1.35 -    /// \note It is synonim of \c edgeMaps().
    1.36 +    /// Gives back the arc/edge maps for the given section.
    1.37 +    /// \note It is synonym of \c edgeMaps().
    1.38      const std::vector<std::string>& arcMaps(int i) const {
    1.39        return _edge_maps[i];
    1.40      }
    1.41  
    1.42      /// @}
    1.43  
    1.44 -    /// \name Edge sections   
    1.45 +    /// \name Synonyms
    1.46      /// @{
    1.47  
    1.48 -    /// \brief Gives back the number of edge sections in the file.
    1.49 +    /// \brief Gives back the number of arc/edge sections in the file.
    1.50      ///
    1.51 -    /// Gives back the number of edge sections in the file.
    1.52 +    /// Gives back the number of arc/edge sections in the file.
    1.53 +    /// \note It is synonym of \c arcSectionNum().
    1.54      int edgeSectionNum() const {
    1.55        return _edge_sections.size();
    1.56      }
    1.57 @@ -2236,6 +2237,7 @@
    1.58      /// \brief Returns the section name at the given position. 
    1.59      ///
    1.60      /// Returns the section name at the given position. 
    1.61 +    /// \note It is synonym of \c arcSection().
    1.62      const std::string& edgeSection(int i) const {
    1.63        return _edge_sections[i];
    1.64      }
    1.65 @@ -2243,6 +2245,7 @@
    1.66      /// \brief Gives back the edge maps for the given section.
    1.67      ///
    1.68      /// Gives back the edge maps for the given section.
    1.69 +    /// \note It is synonym of \c arcMaps().
    1.70      const std::vector<std::string>& edgeMaps(int i) const {
    1.71        return _edge_maps[i];
    1.72      }