[Olena-patches] 2636: Aesthetic changes and documentation updates.

* mln/topo/adj_lower_dim_connected_n_face_iter.hh, * mln/topo/adj_higher_dim_connected_n_face_iter.hh, * tests/io/off/load_bin.cc: Do it. --- milena/ChangeLog | 9 ++++++ .../topo/adj_higher_dim_connected_n_face_iter.hh | 29 +++++++++++--------- .../topo/adj_lower_dim_connected_n_face_iter.hh | 5 +++- milena/tests/io/off/load_bin.cc | 3 +- 4 files changed, 30 insertions(+), 16 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 7af357d..5fa512f 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -24,6 +24,15 @@ 2008-10-22 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Aesthetic changes and documentation updates. + + * mln/topo/adj_lower_dim_connected_n_face_iter.hh, + * mln/topo/adj_higher_dim_connected_n_face_iter.hh, + * tests/io/off/load_bin.cc: + Do it. + +2008-10-22 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + * mln/io/off/load.hh: Polish this file. 2008-10-22 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; diff --git a/milena/mln/topo/adj_higher_dim_connected_n_face_iter.hh b/milena/mln/topo/adj_higher_dim_connected_n_face_iter.hh index ad6dbe9..be619cb 100644 --- a/milena/mln/topo/adj_higher_dim_connected_n_face_iter.hh +++ b/milena/mln/topo/adj_higher_dim_connected_n_face_iter.hh @@ -54,9 +54,9 @@ namespace mln } - /*---------------------------------------------------. + /*----------------------------------------------------. | topo::adj_higher_dim_connected_n_face_fwd_iter<D>. | - `---------------------------------------------------*/ + `----------------------------------------------------*/ /// \brief Forward iterator on all the n-faces sharing an adjacent /// (n+1)-face with a (reference) n-face of an mln::complex<D>. @@ -81,14 +81,17 @@ namespace mln adj_higher_dim_connected_n_face_fwd_iter(const Fref& f_ref); /// \} - /// Compute the set of faces adjacent to the reference face. + /// \brief Compute the set of faces adjacent to the reference face. + /// + /// The computation is delegated to + /// mln::topo::internal::adj_higher_dim_connected_n_face_iterator. void update_adj_faces_(); }; - /*---------------------------------------------------. + /*----------------------------------------------------. | topo::adj_higher_dim_connected_n_face_bkd_iter<D>. | - `---------------------------------------------------*/ + `----------------------------------------------------*/ /// \brief Backward iterator on all the n-faces sharing an adjacent /// (n+1)-face with a (reference) n-face of an mln::complex<D>. @@ -121,9 +124,9 @@ namespace mln }; - /*-------------------------------------------------------------. + /*--------------------------------------------------------------. | topo::internal::adj_higher_dim_connected_n_face_iterator<D>. | - `-------------------------------------------------------------*/ + `--------------------------------------------------------------*/ namespace internal { @@ -144,9 +147,9 @@ namespace mln # ifndef MLN_INCLUDE_ONLY - /*---------------------------------------------------. + /*----------------------------------------------------. | topo::adj_higher_dim_connected_n_face_fwd_iter<D>. | - `---------------------------------------------------*/ + `----------------------------------------------------*/ template <unsigned D> inline @@ -178,9 +181,9 @@ namespace mln } - /*---------------------------------------------------. + /*----------------------------------------------------. | topo::adj_higher_dim_connected_n_face_bkd_iter<D>. | - `---------------------------------------------------*/ + `----------------------------------------------------*/ template <unsigned D> inline @@ -207,9 +210,9 @@ namespace mln } - /*-------------------------------------------------------------. + /*--------------------------------------------------------------. | topo::internal::adj_higher_dim_connected_n_face_iterator<D>. | - `-------------------------------------------------------------*/ + `--------------------------------------------------------------*/ namespace internal { diff --git a/milena/mln/topo/adj_lower_dim_connected_n_face_iter.hh b/milena/mln/topo/adj_lower_dim_connected_n_face_iter.hh index 7a11009..181d439 100644 --- a/milena/mln/topo/adj_lower_dim_connected_n_face_iter.hh +++ b/milena/mln/topo/adj_lower_dim_connected_n_face_iter.hh @@ -81,7 +81,10 @@ namespace mln adj_lower_dim_connected_n_face_fwd_iter(const Fref& f_ref); /// \} - /// Compute the set of faces adjacent to the reference face. + /// \brief Compute the set of faces adjacent to the reference face. + /// + /// The computation is delegated to + /// mln::topo::internal::adj_lower_dim_connected_n_face_iterator. void update_adj_faces_(); }; diff --git a/milena/tests/io/off/load_bin.cc b/milena/tests/io/off/load_bin.cc index 341c874..4474f6e 100644 --- a/milena/tests/io/off/load_bin.cc +++ b/milena/tests/io/off/load_bin.cc @@ -26,8 +26,7 @@ // Public License. /// \file tests/io/off/load_bin.cc -/// \brief Test mln::io::off::load with an -/// mln::complex_image<3, geom::complex_data<3, point3df>, bool>. +/// \brief Test mln::io::off::load with an mln::bin_2complex_image3df. #include <algorithm> #include <iterator> -- 1.6.0.1