[Olena-patches] [PATCH 1/5] Use \tparam properly.

* milena/mln/core/image/complex_image.hh, * milena/mln/core/site_set/p_complex.hh, * milena/mln/util/line_graph.hh, * milena/trash/bgraph_image.hh, * milena/trash/graph_image.hh, * milena/trash/line_graph_image.hh: Use \p instead of \tparam when highlighting a template parameter within a sentence. --- milena/ChangeLog | 13 +++++++++++++ milena/mln/core/image/complex_image.hh | 2 +- milena/mln/core/site_set/p_complex.hh | 2 +- milena/mln/util/line_graph.hh | 2 +- milena/trash/bgraph_image.hh | 2 +- milena/trash/graph_image.hh | 2 +- milena/trash/line_graph_image.hh | 2 +- 7 files changed, 19 insertions(+), 6 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index ee34372..7a68a0c 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,16 @@ +2009-06-09 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + + Use \tparam properly. + + * milena/mln/core/image/complex_image.hh, + * milena/mln/core/site_set/p_complex.hh, + * milena/mln/util/line_graph.hh, + * milena/trash/bgraph_image.hh, + * milena/trash/graph_image.hh, + * milena/trash/line_graph_image.hh: + Use \p instead of \tparam when highlighting a template parameter + within a sentence. + 2009-06-10 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; Fix mln::io::abort(). diff --git a/milena/mln/core/image/complex_image.hh b/milena/mln/core/image/complex_image.hh index 8dadeab..3419778 100644 --- a/milena/mln/core/image/complex_image.hh +++ b/milena/mln/core/image/complex_image.hh @@ -138,7 +138,7 @@ namespace mln /// Return type of read-write access. /// /// We use the associated type \c reference instead of a plain - /// reference on th value type (\tparam V), because it's the only way + /// reference on th value type (\p V), because it's the only way /// to safely form a reference on the element in the case of a /// std::vector<bool>. typedef typename std::vector<V>::reference lvalue; diff --git a/milena/mln/core/site_set/p_complex.hh b/milena/mln/core/site_set/p_complex.hh index eee3e8c..225a70d 100644 --- a/milena/mln/core/site_set/p_complex.hh +++ b/milena/mln/core/site_set/p_complex.hh @@ -103,7 +103,7 @@ namespace mln /* FIXME: Aggregate site data (location). */ /** A complex psite set based on the N-faces of a complex - of dimension \tparam D (a \p D-complex). + of dimension \p D (a \p D-complex). \arg \p D The dimension of the complex. \arg \p G A function object type, associating localization diff --git a/milena/mln/util/line_graph.hh b/milena/mln/util/line_graph.hh index d81e110..f367b77 100644 --- a/milena/mln/util/line_graph.hh +++ b/milena/mln/util/line_graph.hh @@ -74,7 +74,7 @@ namespace mln namespace util { - /// \brief Undirected line graph of a graph of type \tparam G. + /// \brief Undirected line graph of a graph of type \p G. /// /// \ingroup modgraph // diff --git a/milena/trash/bgraph_image.hh b/milena/trash/bgraph_image.hh index d20ecdb..fd7685b 100644 --- a/milena/trash/bgraph_image.hh +++ b/milena/trash/bgraph_image.hh @@ -110,7 +110,7 @@ namespace mln /// Return type of read-write access. /// /// We use the associated type \c reference instead of a plain - /// reference on th value type (\tparam V), because it's the only way + /// reference on th value type (\p V), because it's the only way /// to safely form a reference on the element in the case of a /// std::vector<bool>. typedef typename std::vector<V>::reference lvalue; diff --git a/milena/trash/graph_image.hh b/milena/trash/graph_image.hh index 7cb25e2..b58e729 100644 --- a/milena/trash/graph_image.hh +++ b/milena/trash/graph_image.hh @@ -116,7 +116,7 @@ namespace mln /// \brief Return type of read-write access. /// /// We use the associated type \c reference instead of a plain - /// reference on th value type (\tparam V), because it's the only way + /// reference on th value type (\p V), because it's the only way /// to safely form a reference on the element in the case of a /// std::vector<bool>. typedef typename std::vector<V>::reference lvalue; diff --git a/milena/trash/line_graph_image.hh b/milena/trash/line_graph_image.hh index 0d9e095..63bf1ac 100644 --- a/milena/trash/line_graph_image.hh +++ b/milena/trash/line_graph_image.hh @@ -130,7 +130,7 @@ namespace mln /// \brief Return type of read-write access. /// /// We use the associated type \c reference instead of a plain - /// reference on th value type (\tparam V), because it's the only way + /// reference on th value type (\p V), because it's the only way /// to safely form a reference on the element in the case of a /// std::vector<bool>. typedef typename std::vector<V>::reference lvalue; -- 1.6.1.2