# HG changeset patch
# User Peter Kovacs
# Date 1294611656 -3600
# Node ID 745312f9b44120279b475bfb4e6219d97a906e6e
# Parent e0cef67fe565981494527c12172751fcfe6a477a
Improve the doc of path structures (#406)
diff --git a/lemon/path.h b/lemon/path.h
--- a/lemon/path.h
+++ b/lemon/path.h
@@ -43,7 +43,7 @@
/// \tparam GR The digraph type in which the path is.
///
/// In a sense, the path can be treated as a list of arcs. The
- /// lemon path type stores just this list. As a consequence, it
+ /// LEMON path type stores just this list. As a consequence, it
/// cannot enumerate the nodes of the path and the source node of
/// a zero length path is undefined.
///
@@ -135,7 +135,7 @@
/// \brief Reset the path to an empty one.
void clear() { head.clear(); tail.clear(); }
- /// \brief The nth arc.
+ /// \brief The n-th arc.
///
/// \pre \c n is in the `[0..length() - 1]` range.
const Arc& nth(int n) const {
@@ -143,7 +143,7 @@
*(tail.begin() + (n - head.size()));
}
- /// \brief Initialize arc iterator to point to the nth arc
+ /// \brief Initialize arc iterator to point to the n-th arc
///
/// \pre \c n is in the `[0..length() - 1]` range.
ArcIt nthIt(int n) const {
@@ -231,7 +231,7 @@
/// \tparam GR The digraph type in which the path is.
///
/// In a sense, the path can be treated as a list of arcs. The
- /// lemon path type stores just this list. As a consequence it
+ /// LEMON path type stores just this list. As a consequence it
/// cannot enumerate the nodes in the path and the zero length paths
/// cannot store the source.
///
@@ -327,14 +327,14 @@
/// \brief Reset the path to an empty one.
void clear() { data.clear(); }
- /// \brief The nth arc.
+ /// \brief The n-th arc.
///
/// \pre \c n is in the `[0..length() - 1]` range.
const Arc& nth(int n) const {
return data[n];
}
- /// \brief Initializes arc iterator to point to the nth arc.
+ /// \brief Initializes arc iterator to point to the n-th arc.
ArcIt nthIt(int n) const {
return ArcIt(*this, n);
}
@@ -395,7 +395,7 @@
/// \tparam GR The digraph type in which the path is.
///
/// In a sense, the path can be treated as a list of arcs. The
- /// lemon path type stores just this list. As a consequence it
+ /// LEMON path type stores just this list. As a consequence it
/// cannot enumerate the nodes in the path and the zero length paths
/// cannot store the source.
///
@@ -504,9 +504,9 @@
Node *node;
};
- /// \brief The nth arc.
+ /// \brief The n-th arc.
///
- /// This function looks for the nth arc in O(n) time.
+ /// This function looks for the n-th arc in O(n) time.
/// \pre \c n is in the `[0..length() - 1]` range.
const Arc& nth(int n) const {
Node *node = first;
@@ -516,7 +516,7 @@
return node->arc;
}
- /// \brief Initializes arc iterator to point to the nth arc.
+ /// \brief Initializes arc iterator to point to the n-th arc.
ArcIt nthIt(int n) const {
Node *node = first;
for (int i = 0; i < n; ++i) {
@@ -735,7 +735,7 @@
/// \tparam GR The digraph type in which the path is.
///
/// In a sense, the path can be treated as a list of arcs. The
- /// lemon path type stores just this list. As a consequence it
+ /// LEMON path type stores just this list. As a consequence it
/// cannot enumerate the nodes in the path and the source node of
/// a zero length path is undefined.
///
@@ -831,14 +831,14 @@
int idx;
};
- /// \brief The nth arc.
+ /// \brief The n-th arc.
///
/// \pre \c n is in the `[0..length() - 1]` range.
const Arc& nth(int n) const {
return arcs[n];
}
- /// \brief The arc iterator pointing to the nth arc.
+ /// \brief The arc iterator pointing to the n-th arc.
ArcIt nthIt(int n) const {
return ArcIt(*this, n);
}
@@ -1042,7 +1042,7 @@
/// \brief Class which helps to iterate through the nodes of a path
///
/// In a sense, the path can be treated as a list of arcs. The
- /// lemon path type stores only this list. As a consequence, it
+ /// LEMON path type stores only this list. As a consequence, it
/// cannot enumerate the nodes in the path and the zero length paths
/// cannot have a source node.
///