Improve the doc of path structures (#406)
authorPeter Kovacs <kpeter@inf.elte.hu>
Sun, 09 Jan 2011 23:20:56 +0100
changeset 1024745312f9b441
parent 1023 e0cef67fe565
child 1026 9312d6c89d02
Improve the doc of path structures (#406)
lemon/path.h
     1.1 --- a/lemon/path.h	Sun Jan 09 16:51:14 2011 +0100
     1.2 +++ b/lemon/path.h	Sun Jan 09 23:20:56 2011 +0100
     1.3 @@ -43,7 +43,7 @@
     1.4    /// \tparam GR The digraph type in which the path is.
     1.5    ///
     1.6    /// In a sense, the path can be treated as a list of arcs. The
     1.7 -  /// lemon path type stores just this list. As a consequence, it
     1.8 +  /// LEMON path type stores just this list. As a consequence, it
     1.9    /// cannot enumerate the nodes of the path and the source node of
    1.10    /// a zero length path is undefined.
    1.11    ///
    1.12 @@ -135,7 +135,7 @@
    1.13      /// \brief Reset the path to an empty one.
    1.14      void clear() { head.clear(); tail.clear(); }
    1.15  
    1.16 -    /// \brief The nth arc.
    1.17 +    /// \brief The n-th arc.
    1.18      ///
    1.19      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.20      const Arc& nth(int n) const {
    1.21 @@ -143,7 +143,7 @@
    1.22          *(tail.begin() + (n - head.size()));
    1.23      }
    1.24  
    1.25 -    /// \brief Initialize arc iterator to point to the nth arc
    1.26 +    /// \brief Initialize arc iterator to point to the n-th arc
    1.27      ///
    1.28      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.29      ArcIt nthIt(int n) const {
    1.30 @@ -231,7 +231,7 @@
    1.31    /// \tparam GR The digraph type in which the path is.
    1.32    ///
    1.33    /// In a sense, the path can be treated as a list of arcs. The
    1.34 -  /// lemon path type stores just this list. As a consequence it
    1.35 +  /// LEMON path type stores just this list. As a consequence it
    1.36    /// cannot enumerate the nodes in the path and the zero length paths
    1.37    /// cannot store the source.
    1.38    ///
    1.39 @@ -327,14 +327,14 @@
    1.40      /// \brief Reset the path to an empty one.
    1.41      void clear() { data.clear(); }
    1.42  
    1.43 -    /// \brief The nth arc.
    1.44 +    /// \brief The n-th arc.
    1.45      ///
    1.46      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.47      const Arc& nth(int n) const {
    1.48        return data[n];
    1.49      }
    1.50  
    1.51 -    /// \brief  Initializes arc iterator to point to the nth arc.
    1.52 +    /// \brief  Initializes arc iterator to point to the n-th arc.
    1.53      ArcIt nthIt(int n) const {
    1.54        return ArcIt(*this, n);
    1.55      }
    1.56 @@ -395,7 +395,7 @@
    1.57    /// \tparam GR The digraph type in which the path is.
    1.58    ///
    1.59    /// In a sense, the path can be treated as a list of arcs. The
    1.60 -  /// lemon path type stores just this list. As a consequence it
    1.61 +  /// LEMON path type stores just this list. As a consequence it
    1.62    /// cannot enumerate the nodes in the path and the zero length paths
    1.63    /// cannot store the source.
    1.64    ///
    1.65 @@ -504,9 +504,9 @@
    1.66        Node *node;
    1.67      };
    1.68  
    1.69 -    /// \brief The nth arc.
    1.70 +    /// \brief The n-th arc.
    1.71      ///
    1.72 -    /// This function looks for the nth arc in O(n) time.
    1.73 +    /// This function looks for the n-th arc in O(n) time.
    1.74      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
    1.75      const Arc& nth(int n) const {
    1.76        Node *node = first;
    1.77 @@ -516,7 +516,7 @@
    1.78        return node->arc;
    1.79      }
    1.80  
    1.81 -    /// \brief Initializes arc iterator to point to the nth arc.
    1.82 +    /// \brief Initializes arc iterator to point to the n-th arc.
    1.83      ArcIt nthIt(int n) const {
    1.84        Node *node = first;
    1.85        for (int i = 0; i < n; ++i) {
    1.86 @@ -735,7 +735,7 @@
    1.87    /// \tparam GR The digraph type in which the path is.
    1.88    ///
    1.89    /// In a sense, the path can be treated as a list of arcs. The
    1.90 -  /// lemon path type stores just this list. As a consequence it
    1.91 +  /// LEMON path type stores just this list. As a consequence it
    1.92    /// cannot enumerate the nodes in the path and the source node of
    1.93    /// a zero length path is undefined.
    1.94    ///
    1.95 @@ -831,14 +831,14 @@
    1.96        int idx;
    1.97      };
    1.98  
    1.99 -    /// \brief The nth arc.
   1.100 +    /// \brief The n-th arc.
   1.101      ///
   1.102      /// \pre \c n is in the <tt>[0..length() - 1]</tt> range.
   1.103      const Arc& nth(int n) const {
   1.104        return arcs[n];
   1.105      }
   1.106  
   1.107 -    /// \brief The arc iterator pointing to the nth arc.
   1.108 +    /// \brief The arc iterator pointing to the n-th arc.
   1.109      ArcIt nthIt(int n) const {
   1.110        return ArcIt(*this, n);
   1.111      }
   1.112 @@ -1042,7 +1042,7 @@
   1.113    /// \brief Class which helps to iterate through the nodes of a path
   1.114    ///
   1.115    /// In a sense, the path can be treated as a list of arcs. The
   1.116 -  /// lemon path type stores only this list. As a consequence, it
   1.117 +  /// LEMON path type stores only this list. As a consequence, it
   1.118    /// cannot enumerate the nodes in the path and the zero length paths
   1.119    /// cannot have a source node.
   1.120    ///