[Olena-patches] 1719: Typos and aesthetic changes in documentation of graph-related entities.

https://svn.lrde.epita.fr/svn/oln/trunk/milena Index: ChangeLog from Roland Levillain &lt;roland(a)lrde.epita.fr&gt; Typos and aesthetic changes in documentation of graph-related entities. * mln/core/p_graph_piter.hh, * mln/core/graph_window_piter.hh, * tests/core/graph_elt_window.cc: Fix Doxygen comments. * mln/core/graph_psite.hh: Likewise. (graph_psite<P>::operator[]): s/util::node_id/unsigned/. s/id/i/. mln/core/graph_psite.hh | 8 ++++---- mln/core/graph_window_piter.hh | 4 ++-- mln/core/p_graph_piter.hh | 8 ++++---- tests/core/graph_elt_window.cc | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) Index: mln/core/graph_psite.hh --- mln/core/graph_psite.hh (revision 1718) +++ mln/core/graph_psite.hh (working copy) @@ -74,9 +74,9 @@ util::node_id id() const; private: - // The p_graph this point site belongs to. + /// The p_graph this point site belongs to. const p_graph<P>& pg_; - // The id of the node this psite is pointing towards. + /// The id of the node this psite is pointing towards. util::node_id id_; }; @@ -131,9 +131,9 @@ template<typename P> inline mln_coord(P) - graph_psite<P>::operator[](util::node_id id) const + graph_psite<P>::operator[](unsigned i) const { - return to_point()[id]; + return to_point()[i]; } template<typename P> Index: mln/core/graph_window_piter.hh --- mln/core/graph_window_piter.hh (revision 1718) +++ mln/core/graph_window_piter.hh (working copy) @@ -96,9 +96,9 @@ const psite& p_ref_; /// An internal iterator on the set of nodes of the underlying graph. util::node_id id_; - // The psite corresponding to this iterator. + /// The psite corresponding to this iterator. psite psite_; - // The point corresponding to this iterator. + /// The point corresponding to this iterator. point p_; }; Index: mln/core/p_graph_piter.hh --- mln/core/p_graph_piter.hh (revision 1718) +++ mln/core/p_graph_piter.hh (working copy) @@ -93,13 +93,13 @@ operator psite() const; protected: - // The p_graph this point site belongs to. + /// The p_graph this point site belongs to. const p_graph<P>& pg_; - // The id of the node this psite is pointing towards. + /// The id of the node this psite is pointing towards. unsigned id_; - // The psite corresponding to this iterator. + /// The psite corresponding to this iterator. psite psite_; - // The point corresponding to this iterator. + /// The point corresponding to this iterator. point p_; }; Index: tests/core/graph_elt_window.cc --- tests/core/graph_elt_window.cc (revision 1718) +++ tests/core/graph_elt_window.cc (working copy) @@ -27,7 +27,7 @@ /*! \file tests/core/graph_elt_window.cc * - * \brief Tests on mln::win::graph_elt_window. + * \brief Tests on mln::graph_elt_window. */ #include <vector> @@ -77,6 +77,6 @@ p_graph<p_t> pg(g); // Graph point site. graph_psite<p_t> psite(pg, 0); - // ``Sliding'' window (in fact, neighborhood) of a psite of PG. + // ``Sliding'' window of a psite of PG. graph_elt_window<p_t> win; }