[Olena-patches] olena-2.0-371-g37a7c07 Tag internal documentation.

* apps/graph-morpho/morpho.hh, * mln/accu/internal/couple.hh, * mln/core/box_runend_piter.hh, * mln/core/box_runstart_piter.hh, * mln/core/concept/delta_point_site.hh, * mln/core/concept/dpoint.hh, * mln/core/concept/function.hh, * mln/core/concept/gdpoint.hh, * mln/core/concept/meta_accumulator.hh, * mln/core/concept/neighborhood.hh, * mln/core/concept/pseudo_site.hh, * mln/core/concept/site.hh, * mln/core/concept/site_proxy.hh, * mln/core/concept/site_set.hh, * mln/core/dpoints_pixter.hh, * mln/core/dpsites_piter.hh, * mln/core/image/ch_piter.hh, * mln/core/image/complex_image.hh, * mln/core/image/complex_neighborhood_piter.hh, * mln/core/image/complex_window_piter.hh, * mln/core/image/dmorph/extended.hh, * mln/core/image/dmorph/extension_fun.hh, * mln/core/image/dmorph/extension_ima.hh, * mln/core/image/dmorph/extension_val.hh, * mln/core/image/dmorph/hexa.hh, * mln/core/image/dmorph/hexa_piter.hh, * mln/core/image/dmorph/image2d_h.hh, * mln/core/image/dmorph/image_if.hh, * mln/core/image/dmorph/p2p_image.hh, * mln/core/image/dmorph/slice_image.hh, * mln/core/image/dmorph/sub_image.hh, * mln/core/image/dmorph/sub_image_if.hh, * mln/core/image/dmorph/transformed_image.hh, * mln/core/image/dmorph/unproject_image.hh, * mln/core/image/edge_image.hh, * mln/core/image/flat_image.hh, * mln/core/image/graph_window_if_piter.hh, * mln/core/image/graph_window_piter.hh, * mln/core/image/image1d.hh, * mln/core/image/image2d.hh, * mln/core/image/image3d.hh, * mln/core/image/imorph/decorated_image.hh, * mln/core/image/imorph/interpolated.hh, * mln/core/image/imorph/labeled_image.hh, * mln/core/image/imorph/lazy_image.hh, * mln/core/image/imorph/plain.hh, * mln/core/image/imorph/safe.hh, * mln/core/image/imorph/tr_image.hh, * mln/core/image/vertex_image.hh, * mln/core/image/vmorph/cast_image.hh, * mln/core/image/vmorph/fun_image.hh, * mln/core/image/vmorph/thru_image.hh, * mln/core/image/vmorph/violent_cast_image.hh, * mln/core/internal/box_impl.hh, * mln/core/internal/check/image_fastest.hh, * mln/core/internal/classical_window_base.hh, * mln/core/internal/complex_neighborhood_base.hh, * mln/core/internal/complex_window_base.hh, * mln/core/internal/complex_window_p_base.hh, * mln/core/internal/fixme.hh, * mln/core/internal/graph_psite_base.hh, * mln/core/internal/graph_window_base.hh, * mln/core/internal/image_base.hh, * mln/core/internal/image_domain_morpher.hh, * mln/core/internal/image_identity.hh, * mln/core/internal/image_morpher.hh, * mln/core/internal/image_primary.hh, * mln/core/internal/image_value_morpher.hh, * mln/core/internal/is_masked_impl_selector.hh, * mln/core/internal/labeled_image_base.hh, * mln/core/internal/morpher_lvalue.hh, * mln/core/internal/neighb_base.hh, * mln/core/internal/neighb_niter_base.hh, * mln/core/internal/neighb_niter_impl.hh, * mln/core/internal/neighborhood_base.hh, * mln/core/internal/piter_adaptor.hh, * mln/core/internal/piter_identity.hh, * mln/core/internal/pixel_impl.hh, * mln/core/internal/pixel_iterator_base.hh, * mln/core/internal/pseudo_site_base.hh, * mln/core/internal/run_image.hh, * mln/core/internal/set_of.hh, * mln/core/internal/site_relative_iterator_base.hh, * mln/core/internal/site_set_base.hh, * mln/core/internal/site_set_iterator_base.hh, * mln/core/internal/weighted_window_base.hh, * mln/core/internal/window_base.hh, * mln/core/pixter1d.hh, * mln/core/pixter2d.hh, * mln/core/pixter3d.hh, * mln/core/routine/ops.hh, * mln/core/site_set/attic/p_complex_faces_piter.hh, * mln/core/site_set/attic/p_faces_piter.hh, * mln/core/site_set/box_piter.hh, * mln/core/site_set/complex_psite.hh, * mln/core/site_set/p_array.hh, * mln/core/site_set/p_complex_piter.hh, * mln/core/site_set/p_edges_psite.hh, * mln/core/site_set/p_graph_piter.hh, * mln/core/site_set/p_if_piter.hh, * mln/core/site_set/p_n_faces_piter.hh, * mln/core/site_set/p_run_piter.hh, * mln/core/site_set/p_transformed_piter.hh, * mln/core/site_set/p_vertices_psite.hh, * mln/fun/c.hh, * mln/fun/internal/ch_function_value_impl.hh, * mln/fun/v2v/ch_function_value.hh, * mln/fun/x2x/composed.hh, * mln/geom/complex_geometry.hh, * mln/labeling/blobs.hh, * mln/labeling/blobs_and_compute.hh, * mln/metal/ands.hh, * mln/metal/bexpr.hh, * mln/metal/bool.hh, * mln/metal/converts_to.hh, * mln/metal/equal.hh, * mln/metal/goes_to.hh, * mln/metal/if.hh, * mln/metal/int.hh, * mln/metal/is.hh, * mln/metal/is_a.hh, * mln/metal/is_not.hh, * mln/metal/is_not_a.hh, * mln/pw/image.hh, * mln/pw/internal/image_base.hh, * mln/topo/adj_higher_dim_connected_n_face_iter.hh, * mln/topo/adj_higher_face_iter.hh, * mln/topo/adj_lower_dim_connected_n_face_iter.hh, * mln/topo/adj_lower_face_iter.hh, * mln/topo/adj_lower_higher_face_iter.hh, * mln/topo/adj_m_face_iter.hh, * mln/topo/attic/faces_iter.hh, * mln/topo/center_only_iter.hh, * mln/topo/centered_iter_adapter.hh, * mln/topo/complex.hh, * mln/topo/face_data.hh, * mln/topo/face_iter.hh, * mln/topo/internal/complex_iterator_base.hh, * mln/topo/internal/complex_relative_iterator_base.hh, * mln/topo/internal/complex_relative_iterator_sequence.hh, * mln/topo/internal/complex_set_iterator_base.hh, * mln/topo/n_face_iter.hh, * mln/topo/static_n_face_iter.hh, * mln/trait/ch_function_value.hh, * mln/trait/image/props.hh, * mln/trait/images.hh, * mln/trait/neighborhood.hh, * mln/trait/promote.hh, * mln/trait/site_set/props.hh, * mln/trait/site_sets.hh, * mln/trait/solve.hh, * mln/trait/window/props.hh, * mln/trait/windows.hh, * mln/util/branch_iter.hh, * mln/util/branch_iter_ind.hh, * mln/util/edge.hh, * mln/util/graph.hh, * mln/util/internal/edge_impl.hh, * mln/util/internal/graph_base.hh, * mln/util/internal/graph_iter.hh, * mln/util/internal/vertex_impl.hh, * mln/util/lemmings.hh, * mln/util/line_graph.hh, * mln/util/site_pair.hh, * mln/util/vertex.hh, * mln/value/internal/value_like.hh, * mln/value/viter.hh: Add \internal tag. --- milena/ChangeLog | 172 +++++++++++++++++++ milena/apps/graph-morpho/morpho.hh | 18 ++- milena/mln/accu/internal/couple.hh | 16 +- milena/mln/core/box_runend_piter.hh | 13 +- milena/mln/core/box_runstart_piter.hh | 13 +- milena/mln/core/concept/delta_point_site.hh | 16 ++- milena/mln/core/concept/dpoint.hh | 25 ++-- milena/mln/core/concept/function.hh | 9 +- milena/mln/core/concept/gdpoint.hh | 5 +- milena/mln/core/concept/meta_accumulator.hh | 32 ++-- milena/mln/core/concept/neighborhood.hh | 10 +- milena/mln/core/concept/pseudo_site.hh | 13 +- milena/mln/core/concept/site.hh | 8 +- milena/mln/core/concept/site_proxy.hh | 7 +- milena/mln/core/concept/site_set.hh | 15 +- milena/mln/core/dpoints_pixter.hh | 22 ++- milena/mln/core/dpsites_piter.hh | 28 ++-- milena/mln/core/image/ch_piter.hh | 7 +- milena/mln/core/image/complex_image.hh | 13 +- .../mln/core/image/complex_neighborhood_piter.hh | 13 +- milena/mln/core/image/complex_window_piter.hh | 14 +- milena/mln/core/image/dmorph/extended.hh | 7 +- milena/mln/core/image/dmorph/extension_fun.hh | 7 +- milena/mln/core/image/dmorph/extension_ima.hh | 7 +- milena/mln/core/image/dmorph/extension_val.hh | 7 +- milena/mln/core/image/dmorph/hexa.hh | 14 +- milena/mln/core/image/dmorph/hexa_piter.hh | 19 ++- milena/mln/core/image/dmorph/image2d_h.hh | 3 +- milena/mln/core/image/dmorph/image_if.hh | 8 +- milena/mln/core/image/dmorph/p2p_image.hh | 8 +- milena/mln/core/image/dmorph/slice_image.hh | 7 +- milena/mln/core/image/dmorph/sub_image.hh | 7 +- milena/mln/core/image/dmorph/sub_image_if.hh | 7 +- milena/mln/core/image/dmorph/transformed_image.hh | 9 +- milena/mln/core/image/dmorph/unproject_image.hh | 8 +- milena/mln/core/image/edge_image.hh | 7 +- milena/mln/core/image/flat_image.hh | 7 +- milena/mln/core/image/graph_window_if_piter.hh | 5 +- milena/mln/core/image/graph_window_piter.hh | 28 ++- milena/mln/core/image/image1d.hh | 5 +- milena/mln/core/image/image2d.hh | 18 ++- milena/mln/core/image/image3d.hh | 5 +- milena/mln/core/image/imorph/decorated_image.hh | 8 +- milena/mln/core/image/imorph/interpolated.hh | 7 +- milena/mln/core/image/imorph/labeled_image.hh | 7 +- milena/mln/core/image/imorph/lazy_image.hh | 8 +- milena/mln/core/image/imorph/plain.hh | 9 +- milena/mln/core/image/imorph/safe.hh | 9 +- milena/mln/core/image/imorph/tr_image.hh | 8 +- milena/mln/core/image/vertex_image.hh | 8 +- milena/mln/core/image/vmorph/cast_image.hh | 7 +- milena/mln/core/image/vmorph/fun_image.hh | 9 +- milena/mln/core/image/vmorph/thru_image.hh | 14 +- milena/mln/core/image/vmorph/violent_cast_image.hh | 9 +- milena/mln/core/internal/box_impl.hh | 12 +- milena/mln/core/internal/check/image_fastest.hh | 5 +- milena/mln/core/internal/classical_window_base.hh | 8 +- .../mln/core/internal/complex_neighborhood_base.hh | 16 +- milena/mln/core/internal/complex_window_base.hh | 24 ++- milena/mln/core/internal/complex_window_p_base.hh | 24 ++- milena/mln/core/internal/fixme.hh | 12 +- milena/mln/core/internal/graph_psite_base.hh | 9 +- milena/mln/core/internal/graph_window_base.hh | 10 +- milena/mln/core/internal/image_base.hh | 19 ++- milena/mln/core/internal/image_domain_morpher.hh | 19 ++- milena/mln/core/internal/image_identity.hh | 11 +- milena/mln/core/internal/image_morpher.hh | 13 +- milena/mln/core/internal/image_primary.hh | 10 +- milena/mln/core/internal/image_value_morpher.hh | 14 +- .../mln/core/internal/is_masked_impl_selector.hh | 21 ++- milena/mln/core/internal/labeled_image_base.hh | 26 ++-- milena/mln/core/internal/morpher_lvalue.hh | 10 +- milena/mln/core/internal/neighb_base.hh | 15 +- milena/mln/core/internal/neighb_niter_base.hh | 9 +- milena/mln/core/internal/neighb_niter_impl.hh | 97 +++++++---- milena/mln/core/internal/neighborhood_base.hh | 11 +- milena/mln/core/internal/piter_adaptor.hh | 15 +- milena/mln/core/internal/piter_identity.hh | 15 +- milena/mln/core/internal/pixel_impl.hh | 16 +- milena/mln/core/internal/pixel_iterator_base.hh | 18 ++- milena/mln/core/internal/pseudo_site_base.hh | 13 +- milena/mln/core/internal/run_image.hh | 16 +- milena/mln/core/internal/set_of.hh | 26 ++-- .../core/internal/site_relative_iterator_base.hh | 24 ++-- milena/mln/core/internal/site_set_base.hh | 18 ++- milena/mln/core/internal/site_set_iterator_base.hh | 20 ++- milena/mln/core/internal/weighted_window_base.hh | 13 +- milena/mln/core/internal/window_base.hh | 14 +- milena/mln/core/pixter1d.hh | 13 +- milena/mln/core/pixter2d.hh | 13 +- milena/mln/core/pixter3d.hh | 13 +- milena/mln/core/routine/ops.hh | 32 +++- .../core/site_set/attic/p_complex_faces_piter.hh | 17 ++- milena/mln/core/site_set/attic/p_faces_piter.hh | 17 ++- milena/mln/core/site_set/box_piter.hh | 31 ++-- milena/mln/core/site_set/complex_psite.hh | 5 +- milena/mln/core/site_set/p_array.hh | 20 ++- milena/mln/core/site_set/p_complex_piter.hh | 12 +- milena/mln/core/site_set/p_edges_psite.hh | 9 +- milena/mln/core/site_set/p_graph_piter.hh | 13 +- milena/mln/core/site_set/p_if_piter.hh | 21 ++- milena/mln/core/site_set/p_n_faces_piter.hh | 22 ++- milena/mln/core/site_set/p_run_piter.hh | 17 +- milena/mln/core/site_set/p_transformed_piter.hh | 27 ++-- milena/mln/core/site_set/p_vertices_psite.hh | 10 +- milena/mln/fun/c.hh | 13 +- milena/mln/fun/internal/ch_function_value_impl.hh | 8 +- milena/mln/fun/v2v/ch_function_value.hh | 5 +- milena/mln/fun/x2x/composed.hh | 14 +- milena/mln/geom/complex_geometry.hh | 9 +- milena/mln/labeling/blobs.hh | 8 +- milena/mln/labeling/blobs_and_compute.hh | 7 +- milena/mln/metal/ands.hh | 10 +- milena/mln/metal/bexpr.hh | 31 +++- milena/mln/metal/bool.hh | 13 +- milena/mln/metal/converts_to.hh | 8 +- milena/mln/metal/equal.hh | 11 +- milena/mln/metal/goes_to.hh | 15 +- milena/mln/metal/if.hh | 13 +- milena/mln/metal/int.hh | 8 +- milena/mln/metal/is.hh | 11 +- milena/mln/metal/is_a.hh | 39 +++-- milena/mln/metal/is_not.hh | 13 +- milena/mln/metal/is_not_a.hh | 8 +- milena/mln/pw/image.hh | 8 +- milena/mln/pw/internal/image_base.hh | 13 +- .../topo/adj_higher_dim_connected_n_face_iter.hh | 26 ++-- milena/mln/topo/adj_higher_face_iter.hh | 26 ++-- .../topo/adj_lower_dim_connected_n_face_iter.hh | 27 ++-- milena/mln/topo/adj_lower_face_iter.hh | 26 ++-- milena/mln/topo/adj_lower_higher_face_iter.hh | 25 ++- milena/mln/topo/adj_m_face_iter.hh | 33 +++-- milena/mln/topo/attic/faces_iter.hh | 25 ++- milena/mln/topo/center_only_iter.hh | 35 ++-- milena/mln/topo/centered_iter_adapter.hh | 29 ++-- milena/mln/topo/complex.hh | 88 ++++++---- milena/mln/topo/face_data.hh | 5 +- milena/mln/topo/face_iter.hh | 24 ++- milena/mln/topo/internal/complex_iterator_base.hh | 14 +- .../internal/complex_relative_iterator_base.hh | 47 +++-- .../internal/complex_relative_iterator_sequence.hh | 24 ++- .../mln/topo/internal/complex_set_iterator_base.hh | 13 +- milena/mln/topo/n_face_iter.hh | 23 ++- milena/mln/topo/static_n_face_iter.hh | 31 ++-- milena/mln/trait/ch_function_value.hh | 5 +- milena/mln/trait/image/props.hh | 10 +- milena/mln/trait/images.hh | 4 +- milena/mln/trait/neighborhood.hh | 30 +++- milena/mln/trait/promote.hh | 17 ++- milena/mln/trait/site_set/props.hh | 180 ++++++++++++------- milena/mln/trait/site_sets.hh | 26 ++- milena/mln/trait/solve.hh | 22 ++- milena/mln/trait/window/props.hh | 73 +++++++-- milena/mln/trait/windows.hh | 29 ++- milena/mln/util/branch_iter.hh | 17 +- milena/mln/util/branch_iter_ind.hh | 17 +- milena/mln/util/edge.hh | 5 +- milena/mln/util/graph.hh | 9 +- milena/mln/util/internal/edge_impl.hh | 32 ++--- milena/mln/util/internal/graph_base.hh | 7 +- milena/mln/util/internal/graph_iter.hh | 27 ++- milena/mln/util/internal/vertex_impl.hh | 27 +-- milena/mln/util/lemmings.hh | 6 +- milena/mln/util/line_graph.hh | 7 +- milena/mln/util/site_pair.hh | 9 +- milena/mln/util/vertex.hh | 7 +- milena/mln/value/internal/value_like.hh | 15 +- milena/mln/value/viter.hh | 23 ++- 168 files changed, 2029 insertions(+), 1021 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 5ee5aff..756259b 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,177 @@ 2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Tag internal documentation. + + * apps/graph-morpho/morpho.hh, + * mln/accu/internal/couple.hh, + * mln/core/box_runend_piter.hh, + * mln/core/box_runstart_piter.hh, + * mln/core/concept/delta_point_site.hh, + * mln/core/concept/dpoint.hh, + * mln/core/concept/function.hh, + * mln/core/concept/gdpoint.hh, + * mln/core/concept/meta_accumulator.hh, + * mln/core/concept/neighborhood.hh, + * mln/core/concept/pseudo_site.hh, + * mln/core/concept/site.hh, + * mln/core/concept/site_proxy.hh, + * mln/core/concept/site_set.hh, + * mln/core/dpoints_pixter.hh, + * mln/core/dpsites_piter.hh, + * mln/core/image/ch_piter.hh, + * mln/core/image/complex_image.hh, + * mln/core/image/complex_neighborhood_piter.hh, + * mln/core/image/complex_window_piter.hh, + * mln/core/image/dmorph/extended.hh, + * mln/core/image/dmorph/extension_fun.hh, + * mln/core/image/dmorph/extension_ima.hh, + * mln/core/image/dmorph/extension_val.hh, + * mln/core/image/dmorph/hexa.hh, + * mln/core/image/dmorph/hexa_piter.hh, + * mln/core/image/dmorph/image2d_h.hh, + * mln/core/image/dmorph/image_if.hh, + * mln/core/image/dmorph/p2p_image.hh, + * mln/core/image/dmorph/slice_image.hh, + * mln/core/image/dmorph/sub_image.hh, + * mln/core/image/dmorph/sub_image_if.hh, + * mln/core/image/dmorph/transformed_image.hh, + * mln/core/image/dmorph/unproject_image.hh, + * mln/core/image/edge_image.hh, + * mln/core/image/flat_image.hh, + * mln/core/image/graph_window_if_piter.hh, + * mln/core/image/graph_window_piter.hh, + * mln/core/image/image1d.hh, + * mln/core/image/image2d.hh, + * mln/core/image/image3d.hh, + * mln/core/image/imorph/decorated_image.hh, + * mln/core/image/imorph/interpolated.hh, + * mln/core/image/imorph/labeled_image.hh, + * mln/core/image/imorph/lazy_image.hh, + * mln/core/image/imorph/plain.hh, + * mln/core/image/imorph/safe.hh, + * mln/core/image/imorph/tr_image.hh, + * mln/core/image/vertex_image.hh, + * mln/core/image/vmorph/cast_image.hh, + * mln/core/image/vmorph/fun_image.hh, + * mln/core/image/vmorph/thru_image.hh, + * mln/core/image/vmorph/violent_cast_image.hh, + * mln/core/internal/box_impl.hh, + * mln/core/internal/check/image_fastest.hh, + * mln/core/internal/classical_window_base.hh, + * mln/core/internal/complex_neighborhood_base.hh, + * mln/core/internal/complex_window_base.hh, + * mln/core/internal/complex_window_p_base.hh, + * mln/core/internal/fixme.hh, + * mln/core/internal/graph_psite_base.hh, + * mln/core/internal/graph_window_base.hh, + * mln/core/internal/image_base.hh, + * mln/core/internal/image_domain_morpher.hh, + * mln/core/internal/image_identity.hh, + * mln/core/internal/image_morpher.hh, + * mln/core/internal/image_primary.hh, + * mln/core/internal/image_value_morpher.hh, + * mln/core/internal/is_masked_impl_selector.hh, + * mln/core/internal/labeled_image_base.hh, + * mln/core/internal/morpher_lvalue.hh, + * mln/core/internal/neighb_base.hh, + * mln/core/internal/neighb_niter_base.hh, + * mln/core/internal/neighb_niter_impl.hh, + * mln/core/internal/neighborhood_base.hh, + * mln/core/internal/piter_adaptor.hh, + * mln/core/internal/piter_identity.hh, + * mln/core/internal/pixel_impl.hh, + * mln/core/internal/pixel_iterator_base.hh, + * mln/core/internal/pseudo_site_base.hh, + * mln/core/internal/run_image.hh, + * mln/core/internal/set_of.hh, + * mln/core/internal/site_relative_iterator_base.hh, + * mln/core/internal/site_set_base.hh, + * mln/core/internal/site_set_iterator_base.hh, + * mln/core/internal/weighted_window_base.hh, + * mln/core/internal/window_base.hh, + * mln/core/pixter1d.hh, + * mln/core/pixter2d.hh, + * mln/core/pixter3d.hh, + * mln/core/routine/ops.hh, + * mln/core/site_set/attic/p_complex_faces_piter.hh, + * mln/core/site_set/attic/p_faces_piter.hh, + * mln/core/site_set/box_piter.hh, + * mln/core/site_set/complex_psite.hh, + * mln/core/site_set/p_array.hh, + * mln/core/site_set/p_complex_piter.hh, + * mln/core/site_set/p_edges_psite.hh, + * mln/core/site_set/p_graph_piter.hh, + * mln/core/site_set/p_if_piter.hh, + * mln/core/site_set/p_n_faces_piter.hh, + * mln/core/site_set/p_run_piter.hh, + * mln/core/site_set/p_transformed_piter.hh, + * mln/core/site_set/p_vertices_psite.hh, + * mln/fun/c.hh, + * mln/fun/internal/ch_function_value_impl.hh, + * mln/fun/v2v/ch_function_value.hh, + * mln/fun/x2x/composed.hh, + * mln/geom/complex_geometry.hh, + * mln/labeling/blobs.hh, + * mln/labeling/blobs_and_compute.hh, + * mln/metal/ands.hh, + * mln/metal/bexpr.hh, + * mln/metal/bool.hh, + * mln/metal/converts_to.hh, + * mln/metal/equal.hh, + * mln/metal/goes_to.hh, + * mln/metal/if.hh, + * mln/metal/int.hh, + * mln/metal/is.hh, + * mln/metal/is_a.hh, + * mln/metal/is_not.hh, + * mln/metal/is_not_a.hh, + * mln/pw/image.hh, + * mln/pw/internal/image_base.hh, + * mln/topo/adj_higher_dim_connected_n_face_iter.hh, + * mln/topo/adj_higher_face_iter.hh, + * mln/topo/adj_lower_dim_connected_n_face_iter.hh, + * mln/topo/adj_lower_face_iter.hh, + * mln/topo/adj_lower_higher_face_iter.hh, + * mln/topo/adj_m_face_iter.hh, + * mln/topo/attic/faces_iter.hh, + * mln/topo/center_only_iter.hh, + * mln/topo/centered_iter_adapter.hh, + * mln/topo/complex.hh, + * mln/topo/face_data.hh, + * mln/topo/face_iter.hh, + * mln/topo/internal/complex_iterator_base.hh, + * mln/topo/internal/complex_relative_iterator_base.hh, + * mln/topo/internal/complex_relative_iterator_sequence.hh, + * mln/topo/internal/complex_set_iterator_base.hh, + * mln/topo/n_face_iter.hh, + * mln/topo/static_n_face_iter.hh, + * mln/trait/ch_function_value.hh, + * mln/trait/image/props.hh, + * mln/trait/images.hh, + * mln/trait/neighborhood.hh, + * mln/trait/promote.hh, + * mln/trait/site_set/props.hh, + * mln/trait/site_sets.hh, + * mln/trait/solve.hh, + * mln/trait/window/props.hh, + * mln/trait/windows.hh, + * mln/util/branch_iter.hh, + * mln/util/branch_iter_ind.hh, + * mln/util/edge.hh, + * mln/util/graph.hh, + * mln/util/internal/edge_impl.hh, + * mln/util/internal/graph_base.hh, + * mln/util/internal/graph_iter.hh, + * mln/util/internal/vertex_impl.hh, + * mln/util/lemmings.hh, + * mln/util/line_graph.hh, + * mln/util/site_pair.hh, + * mln/util/vertex.hh, + * mln/value/internal/value_like.hh, + * mln/value/viter.hh: Add \internal tag. + +2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + * mln/core/internal/image_base.hh: Set documentation as internal. 2013-03-08 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; diff --git a/milena/apps/graph-morpho/morpho.hh b/milena/apps/graph-morpho/morpho.hh index bcdcdd9..c1e8484 100644 --- a/milena/apps/graph-morpho/morpho.hh +++ b/milena/apps/graph-morpho/morpho.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -68,7 +69,10 @@ namespace trait { - /// Graph traits. + /*! + \internal + \brief Graph traits. + */ template <typename I> struct graph { @@ -89,7 +93,10 @@ namespace trait // Graph traits for (mln::image2d-based) cubical 2-complexes. // // ----------------------------------------------------------- // - /// Graph traits for mln::image2d. + /*! + \internal + \brief Graph traits for mln::image2d. + */ template <typename T> struct graph< mln::image2d<T> > { @@ -128,7 +135,10 @@ namespace trait // Graph traits for (general) 1-complexes. // // ---------------------------------------- // - /// Graph traits for 1-complexes images. + /*! + \internal + \brief Graph traits for 1-complexes images. + */ template <typename G, typename V> struct graph< mln::complex_image<1, G, V> > { diff --git a/milena/mln/accu/internal/couple.hh b/milena/mln/accu/internal/couple.hh index 55c6cc4..2e861b3 100644 --- a/milena/mln/accu/internal/couple.hh +++ b/milena/mln/accu/internal/couple.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -47,11 +48,14 @@ namespace mln namespace internal { - /// Base implementation of a couple of accumulators. - /// - /// The parameter \c T is the type of values. - /// - /// \todo Check that, when T is not provided, A1 and A2 have the same value. + /*! + \internal + \brief Base implementation of a couple of accumulators. + + The parameter \c T is the type of values. + + \todo Check that, when T is not provided, A1 and A2 have the same value. + */ template <typename A1, typename A2, typename R, typename E> class couple : public base<R,E>, diff --git a/milena/mln/core/box_runend_piter.hh b/milena/mln/core/box_runend_piter.hh index e40760f..fdb886f 100644 --- a/milena/mln/core/box_runend_piter.hh +++ b/milena/mln/core/box_runend_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -41,10 +42,12 @@ namespace mln { - /*! \brief A generic backward iterator on points by lines. - * - * The parameter \c P is the type of points. - */ + /*! + \internal + \brief A generic backward iterator on points by lines. + + The parameter \c P is the type of points. + */ template <typename P> class box_runend_piter : public internal::site_set_iterator_base< box<P>, diff --git a/milena/mln/core/box_runstart_piter.hh b/milena/mln/core/box_runstart_piter.hh index d031a2b..dec4a42 100644 --- a/milena/mln/core/box_runstart_piter.hh +++ b/milena/mln/core/box_runstart_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,10 +42,12 @@ namespace mln { - /*! \brief A generic forward iterator on points by lines. - * - * The parameter \c P is the type of points. - */ + /*! + \internal + \brief A generic forward iterator on points by lines. + + The parameter \c P is the type of points. + */ template <typename P> class box_runstart_piter : public internal::site_set_iterator_base< box<P>, diff --git a/milena/mln/core/concept/delta_point_site.hh b/milena/mln/core/concept/delta_point_site.hh index 693320f..b7107a9 100644 --- a/milena/mln/core/concept/delta_point_site.hh +++ b/milena/mln/core/concept/delta_point_site.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -65,7 +66,10 @@ namespace mln - /// Delta point site category flag type. + /*! + \internal + \brief Delta point site category flag type. + */ template <> struct Delta_Point_Site<void> { @@ -73,8 +77,10 @@ namespace mln }; - /*! \brief FIXME: Doc! - */ + /*! + \internal + \brief FIXME: Doc! + */ template <typename E> struct Delta_Point_Site : public Object<E> { @@ -101,7 +107,7 @@ namespace mln // Operators. template <typename D> - std::ostream& + std::ostream& operator<<(std::ostream& ostr, const Delta_Point_Site<D>& dp); diff --git a/milena/mln/core/concept/dpoint.hh b/milena/mln/core/concept/dpoint.hh index 80f8ae6..7b2fa39 100644 --- a/milena/mln/core/concept/dpoint.hh +++ b/milena/mln/core/concept/dpoint.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -49,16 +50,18 @@ namespace mln }; - /*! \brief Base class for implementation of delta-point classes. - * - * A delta-point is a vector defined by a couple of points. - * - * Given two points, A and B, the vector AB is mapped into the - * delta-point D = AB. Practically one can write: D = B - A. - * - * \see mln::doc::Dpoint for a complete documentation of this class - * contents. - */ + /*! + \internal + \brief Base class for implementation of delta-point classes. + + A delta-point is a vector defined by a couple of points. + + Given two points, A and B, the vector AB is mapped into the + delta-point D = AB. Practically one can write: D = B - A. + + \see mln::doc::Dpoint for a complete documentation of this class + contents. + */ template <typename E> struct Dpoint : public Delta_Point_Site<E> { diff --git a/milena/mln/core/concept/function.hh b/milena/mln/core/concept/function.hh index 22e338e..361c893 100644 --- a/milena/mln/core/concept/function.hh +++ b/milena/mln/core/concept/function.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -46,7 +46,10 @@ namespace mln template <typename E> struct Function_vv2b; - /// Function category flag type. + /*! + \internal + \brief Function category flag type. + */ template <> struct Function<void> { diff --git a/milena/mln/core/concept/gdpoint.hh b/milena/mln/core/concept/gdpoint.hh index 2a7adf9..b8ef9cf 100644 --- a/milena/mln/core/concept/gdpoint.hh +++ b/milena/mln/core/concept/gdpoint.hh @@ -83,7 +83,10 @@ namespace mln - /// Delta point site category flag type. + /*! + \internal + \brief Delta point site category flag type. + */ template <> struct Gdpoint<void> { diff --git a/milena/mln/core/concept/meta_accumulator.hh b/milena/mln/core/concept/meta_accumulator.hh index f00a0c6..c86bde5 100644 --- a/milena/mln/core/concept/meta_accumulator.hh +++ b/milena/mln/core/concept/meta_accumulator.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -62,9 +62,11 @@ namespace mln namespace internal { - /// Make the type resolution easier for the compiler. - /// Introduced for ICC compatibility. - // + /*! + \internal + \brief Make the type resolution easier for the compiler. + Introduced for ICC compatibility. + */ template <typename A, typename T> struct meta_accu_ret_result_helper { @@ -72,9 +74,11 @@ namespace mln }; - /// Make the type resolution easier for the compiler. - /// Introduced for ICC compatibility. - // + /*! + \internal + \brief Make the type resolution easier for the compiler. + Introduced for ICC compatibility. + */ template <typename A, typename T> struct accu_with_helper { @@ -92,12 +96,14 @@ namespace mln typedef Object<void> super; }; - /*! \brief Base class for implementation of meta accumulators. - * - * The parameter \a E is the exact type. - * - * \see mln::doc::Meta_Accumulator for a complete documentation of - * this class contents. + /*! + \internal + \brief Base class for implementation of meta accumulators. + + The parameter \a E is the exact type. + + \see mln::doc::Meta_Accumulator for a complete documentation of + this class contents. */ template <typename E> struct Meta_Accumulator : public Object<E> diff --git a/milena/mln/core/concept/neighborhood.hh b/milena/mln/core/concept/neighborhood.hh index 3fa0521..00fb222 100644 --- a/milena/mln/core/concept/neighborhood.hh +++ b/milena/mln/core/concept/neighborhood.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,8 +49,10 @@ namespace mln template <typename E> struct Neighborhood; - /// Neighborhood category flag type. - + /*! + \internal + \brief Neighborhood category flag type. + */ template <> struct Neighborhood<void> { diff --git a/milena/mln/core/concept/pseudo_site.hh b/milena/mln/core/concept/pseudo_site.hh index b550baf..77eb961 100644 --- a/milena/mln/core/concept/pseudo_site.hh +++ b/milena/mln/core/concept/pseudo_site.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -48,7 +48,10 @@ namespace mln - /// Pseudo_Site category flag type. + /*! + \internal + \brief Pseudo_Site category flag type. + */ template <> struct Pseudo_Site<void> { @@ -125,7 +128,7 @@ namespace mln template <> struct helper< /* is an Object */ true > { - + template <typename P> void change_target(Pseudo_Site<P>& p, const mln_target(P)& new_target) const @@ -138,7 +141,7 @@ namespace mln { // No-op. } - + }; template <> @@ -150,7 +153,7 @@ namespace mln // No-op. } }; - + } // namespace mln::if_possible::internal diff --git a/milena/mln/core/concept/site.hh b/milena/mln/core/concept/site.hh index cc6c73d..68a4bcb 100644 --- a/milena/mln/core/concept/site.hh +++ b/milena/mln/core/concept/site.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,7 +42,10 @@ namespace mln template <typename E> struct Site; - /// Site category flag type. + /*! + \internal + \brief Site category flag type. + */ template <> struct Site<void> { diff --git a/milena/mln/core/concept/site_proxy.hh b/milena/mln/core/concept/site_proxy.hh index 2d964e7..8293423 100644 --- a/milena/mln/core/concept/site_proxy.hh +++ b/milena/mln/core/concept/site_proxy.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -45,7 +45,10 @@ namespace mln template <typename E> struct Site_Proxy; - /// Site_Proxy category flag type. + /*! + \internal + \brief Site_Proxy category flag type. + */ template <> struct Site_Proxy<void> { diff --git a/milena/mln/core/concept/site_set.hh b/milena/mln/core/concept/site_set.hh index 2e25f93..dc1885b 100644 --- a/milena/mln/core/concept/site_set.hh +++ b/milena/mln/core/concept/site_set.hh @@ -50,7 +50,10 @@ namespace mln template <typename E> struct Site_Set; - /// Site_Set category flag type. + /*! + \internal + \brief Site_Set category flag type. + */ template <> struct Site_Set<void> { @@ -58,10 +61,12 @@ namespace mln }; - /// Base class for implementation classes of site sets. - /// - /// \see mln::doc::Site_Set for a complete documentation of this - /// class contents. + /*! + \brief Base class for implementation classes of site sets. + + \see mln::doc::Site_Set for a complete documentation of this + class contents. + */ template <typename E> struct Site_Set : public Object<E> { diff --git a/milena/mln/core/dpoints_pixter.hh b/milena/mln/core/dpoints_pixter.hh index aeea333..2a79e12 100644 --- a/milena/mln/core/dpoints_pixter.hh +++ b/milena/mln/core/dpoints_pixter.hh @@ -50,10 +50,13 @@ namespace mln | dpoints_fwd_pixter<I>. | `------------------------*/ - /// \brief A generic forward iterator on the pixels of a - /// dpoint-based window or neighborhood. - /// - /// Parameter \c I is the image type. + /*! + \internal + \brief A generic forward iterator on the pixels of a + dpoint-based window or neighborhood. + + Parameter \c I is the image type. + */ template <typename I> class dpoints_fwd_pixter : public Pixel_Iterator< dpoints_fwd_pixter<I> >, @@ -133,10 +136,13 @@ namespace mln | dpoints_bkd_pixter<I>. | `------------------------*/ - /// \brief A generic backward iterator on the pixels of a - /// dpoint-based window or neighborhood. - /// - /// Parameter \c I is the image type. + /*! + \internal + \brief A generic backward iterator on the pixels of a + dpoint-based window or neighborhood. + + Parameter \c I is the image type. + */ template <typename I> class dpoints_bkd_pixter : public Pixel_Iterator< dpoints_bkd_pixter<I> >, diff --git a/milena/mln/core/dpsites_piter.hh b/milena/mln/core/dpsites_piter.hh index 0bbb0f5..927ac6b 100644 --- a/milena/mln/core/dpsites_piter.hh +++ b/milena/mln/core/dpsites_piter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -39,11 +39,14 @@ namespace mln { - /// A generic forward iterator on points of windows and of - /// neighborhoods. - /// - /// The parameter \c V is the type of std::vector enclosing - /// structure. + /*! + \internal + \brief A generic forward iterator on points of windows and of + neighborhoods. + + The parameter \c V is the type of std::vector enclosing + structure. + */ template <typename V> class dpsites_fwd_piter : public internal::site_relative_iterator_base< V, dpsites_fwd_piter<V> > @@ -85,11 +88,14 @@ namespace mln }; - /// A generic backward iterator on points of windows and of - /// neighborhoods. - /// - /// The parameter \c V is the type of std::vector enclosing - /// structure. + /*! + \internal + \brief A generic backward iterator on points of windows and of + neighborhoods. + + The parameter \c V is the type of std::vector enclosing + structure. + */ template <typename V> class dpsites_bkd_piter : public internal::site_relative_iterator_base< V, dpsites_bkd_piter<V> > diff --git a/milena/mln/core/image/ch_piter.hh b/milena/mln/core/image/ch_piter.hh index b7c53f8..2677edd 100644 --- a/milena/mln/core/image/ch_piter.hh +++ b/milena/mln/core/image/ch_piter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -47,7 +47,10 @@ namespace mln namespace internal { - /// \internal Data structure for \c mln::ch_piter_image<I,Fwd>. + /*! + \internal + \brief Data structure for \c mln::ch_piter_image<I,Fwd>. + */ template <typename I, typename Fwd> struct data< ch_piter_image<I,Fwd> > { diff --git a/milena/mln/core/image/complex_image.hh b/milena/mln/core/image/complex_image.hh index 07c6e91..d6b7480 100644 --- a/milena/mln/core/image/complex_image.hh +++ b/milena/mln/core/image/complex_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -52,7 +53,10 @@ namespace mln namespace internal { - /// A boolean proxy, used to fool std::vector. + /*! + \internal + \brief A boolean proxy, used to fool std::vector. + */ struct bool_proxy { public: @@ -94,7 +98,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::complex_image. + /*! + \internal + \brief Data structure for \c mln::complex_image. + */ template <unsigned D, typename G, typename V> struct data< complex_image<D, G, V> > { diff --git a/milena/mln/core/image/complex_neighborhood_piter.hh b/milena/mln/core/image/complex_neighborhood_piter.hh index 6298aac..51c049a 100644 --- a/milena/mln/core/image/complex_neighborhood_piter.hh +++ b/milena/mln/core/image/complex_neighborhood_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -48,7 +49,10 @@ namespace mln | complex_neighborhood_fwd_piter<I, G, N>. | `------------------------------------------*/ - /// \brief Forward iterator on complex neighborhood. + /*! + \internal + \brief Forward iterator on complex neighborhood. + */ template <typename I, typename G, typename N> class complex_neighborhood_fwd_piter : public internal::site_relative_iterator_base< N, @@ -119,7 +123,10 @@ namespace mln | complex_neighborhood_bkd_piter<I, G, N>. | `------------------------------------------*/ - /// \brief Backward iterator on complex neighborhood. + /*! + \internal + \brief Backward iterator on complex neighborhood. + */ template <typename I, typename G, typename N> class complex_neighborhood_bkd_piter : public internal::site_relative_iterator_base< N, diff --git a/milena/mln/core/image/complex_window_piter.hh b/milena/mln/core/image/complex_window_piter.hh index ab6326c..208d4e6 100644 --- a/milena/mln/core/image/complex_window_piter.hh +++ b/milena/mln/core/image/complex_window_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2010, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2010, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,10 @@ namespace mln | complex_window_fwd_piter<I, G, W>. | `------------------------------------*/ - /// \brief Forward iterator on complex window. + /*! + \internal + \brief Forward iterator on complex window. + */ template <typename I, typename G, typename W> class complex_window_fwd_piter : public internal::site_relative_iterator_base< W, @@ -119,7 +122,10 @@ namespace mln | complex_window_bkd_piter<I, G, W>. | `------------------------------------*/ - /// \brief Backward iterator on complex window. + /*! + \internal + \brief Backward iterator on complex window. + */ template <typename I, typename G, typename W> class complex_window_bkd_piter : public internal::site_relative_iterator_base< W, diff --git a/milena/mln/core/image/dmorph/extended.hh b/milena/mln/core/image/dmorph/extended.hh index 791ab1d..ed94a04 100644 --- a/milena/mln/core/image/dmorph/extended.hh +++ b/milena/mln/core/image/dmorph/extended.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -50,7 +50,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::extended<I>. + /*! + \internal + \brief Data structure for \c mln::extended<I>. + */ template <typename I> struct data< extended<I> > { diff --git a/milena/mln/core/image/dmorph/extension_fun.hh b/milena/mln/core/image/dmorph/extension_fun.hh index 887fe02..aa5274e 100644 --- a/milena/mln/core/image/dmorph/extension_fun.hh +++ b/milena/mln/core/image/dmorph/extension_fun.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -49,7 +49,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::extension_fun<I, F>. + /*! + \internal + \brief Data structure for \c mln::extension_fun<I, F>. + */ template <typename I, typename F> struct data< extension_fun<I, F> > { diff --git a/milena/mln/core/image/dmorph/extension_ima.hh b/milena/mln/core/image/dmorph/extension_ima.hh index 63ea0ed..d194b82 100644 --- a/milena/mln/core/image/dmorph/extension_ima.hh +++ b/milena/mln/core/image/dmorph/extension_ima.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -46,7 +46,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::extension_ima<I, J>. + /*! + \internal + \brief Data structure for \c mln::extension_ima<I, J>. + */ template <typename I, typename J> struct data< extension_ima<I, J> > { diff --git a/milena/mln/core/image/dmorph/extension_val.hh b/milena/mln/core/image/dmorph/extension_val.hh index c0ccbe0..e5ecef7 100644 --- a/milena/mln/core/image/dmorph/extension_val.hh +++ b/milena/mln/core/image/dmorph/extension_val.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -48,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::extension_val<I>. + /*! + \internal + \brief Data structure for \c mln::extension_val<I>. + */ template <typename I> struct data< extension_val<I> > { diff --git a/milena/mln/core/image/dmorph/hexa.hh b/milena/mln/core/image/dmorph/hexa.hh index 314cba1..cd856bd 100644 --- a/milena/mln/core/image/dmorph/hexa.hh +++ b/milena/mln/core/image/dmorph/hexa.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -48,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::hexa<I>. + /*! + \internal + \brief Data structure for \c mln::hexa<I>. + */ template <typename I> struct data< hexa<I> > { @@ -63,7 +66,10 @@ namespace mln namespace trait { - /// FIXME: use the right properties. + /*! + \internal + FIXME: use the right properties. + */ template <typename I> struct image_< hexa<I> > : default_image_morpher< I, mln_value(I), hexa<I> > diff --git a/milena/mln/core/image/dmorph/hexa_piter.hh b/milena/mln/core/image/dmorph/hexa_piter.hh index 97b2077..d4841cd 100644 --- a/milena/mln/core/image/dmorph/hexa_piter.hh +++ b/milena/mln/core/image/dmorph/hexa_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -39,13 +40,15 @@ namespace mln { - /// A generic forward iterator on points of subsets. - /// - /// Parameter \c S is a point set type; parameter F is a function - /// from point to Boolean. - /// - /// \see mln::hexa - /// + /*! + \internal + \brief A generic forward iterator on points of subsets. + + Parameter \c S is a point set type; parameter F is a function + from point to Boolean. + + \see mln::hexa + */ template <typename S> class hexa_fwd_piter_ : public internal::piter_adaptor_< mln_fwd_piter(S), diff --git a/milena/mln/core/image/dmorph/image2d_h.hh b/milena/mln/core/image/dmorph/image2d_h.hh index adcb272..35dcf5a 100644 --- a/milena/mln/core/image/dmorph/image2d_h.hh +++ b/milena/mln/core/image/dmorph/image2d_h.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // diff --git a/milena/mln/core/image/dmorph/image_if.hh b/milena/mln/core/image/dmorph/image_if.hh index 58b6106..ed9a05a 100644 --- a/milena/mln/core/image/dmorph/image_if.hh +++ b/milena/mln/core/image/dmorph/image_if.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -47,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::image_if<I,F>. + /*! + \internal + \brief Data structure for \c mln::image_if<I,F>. + */ template <typename I, typename F> struct data< image_if<I,F> > { diff --git a/milena/mln/core/image/dmorph/p2p_image.hh b/milena/mln/core/image/dmorph/p2p_image.hh index ca1b3d5..3b2c563 100644 --- a/milena/mln/core/image/dmorph/p2p_image.hh +++ b/milena/mln/core/image/dmorph/p2p_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,7 +46,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::p2p_image<I,F>. + /*! + \internal + \brief Data structure for \c mln::p2p_image<I,F>. + */ template <typename I, typename F> struct data< p2p_image<I,F> > { diff --git a/milena/mln/core/image/dmorph/slice_image.hh b/milena/mln/core/image/dmorph/slice_image.hh index a5e2983..c779858 100644 --- a/milena/mln/core/image/dmorph/slice_image.hh +++ b/milena/mln/core/image/dmorph/slice_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -49,7 +49,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::slice_image<I>. + /*! + \internal + \brief Data structure for \c mln::slice_image<I>. + */ template <typename I> struct data< slice_image<I> > { diff --git a/milena/mln/core/image/dmorph/sub_image.hh b/milena/mln/core/image/dmorph/sub_image.hh index d266ce6..bf42c75 100644 --- a/milena/mln/core/image/dmorph/sub_image.hh +++ b/milena/mln/core/image/dmorph/sub_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -50,7 +50,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::sub_image<I,S>. + /*! + \internal + \brief Data structure for \c mln::sub_image<I,S>. + */ template <typename I, typename S> struct data< sub_image<I,S> > { diff --git a/milena/mln/core/image/dmorph/sub_image_if.hh b/milena/mln/core/image/dmorph/sub_image_if.hh index 2cc9661..f4c9fe2 100644 --- a/milena/mln/core/image/dmorph/sub_image_if.hh +++ b/milena/mln/core/image/dmorph/sub_image_if.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -53,7 +53,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::sub_image_if<I,S>. + /*! + \internal + \brief Data structure for \c mln::sub_image_if<I,S>. + */ template <typename I, typename S> struct data< sub_image_if<I,S> > { diff --git a/milena/mln/core/image/dmorph/transformed_image.hh b/milena/mln/core/image/dmorph/transformed_image.hh index 0fb4509..2a7970b 100644 --- a/milena/mln/core/image/dmorph/transformed_image.hh +++ b/milena/mln/core/image/dmorph/transformed_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2011, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::transformed_image<I,F>. + /*! + \internal + \brief Data structure for \c mln::transformed_image<I,F>. + */ template <typename I, typename F> struct data< transformed_image<I,F> > { diff --git a/milena/mln/core/image/dmorph/unproject_image.hh b/milena/mln/core/image/dmorph/unproject_image.hh index 6a79012..1f6c078 100644 --- a/milena/mln/core/image/dmorph/unproject_image.hh +++ b/milena/mln/core/image/dmorph/unproject_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -47,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::unproject_image<I,D,F>. + /*! + \internal + \brief Data structure for \c mln::unproject_image<I,D,F>. + */ template <typename I, typename D, typename F> struct data< unproject_image<I,D,F> > { diff --git a/milena/mln/core/image/edge_image.hh b/milena/mln/core/image/edge_image.hh index 1c19b07..5be1ff0 100644 --- a/milena/mln/core/image/edge_image.hh +++ b/milena/mln/core/image/edge_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -66,7 +67,9 @@ namespace mln namespace internal { - /// Data structure for mln::pw::internal::image + /*! \internal + \brief Data structure for mln::pw::internal::image + */ template <typename P, typename V, typename G> struct data< mln::edge_image<P,V,G> > { diff --git a/milena/mln/core/image/flat_image.hh b/milena/mln/core/image/flat_image.hh index 6647766..813f29c 100644 --- a/milena/mln/core/image/flat_image.hh +++ b/milena/mln/core/image/flat_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -48,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::flat_image<T,S>. + /*! + \internal + \brief Data structure for \c mln::flat_image<T,S>. + */ template <typename T, typename S> struct data< flat_image<T,S> > { diff --git a/milena/mln/core/image/graph_window_if_piter.hh b/milena/mln/core/image/graph_window_if_piter.hh index 1060f15..7a865e1 100644 --- a/milena/mln/core/image/graph_window_if_piter.hh +++ b/milena/mln/core/image/graph_window_if_piter.hh @@ -44,7 +44,10 @@ namespace mln - /// Forward iterator on line graph window. + /*! + \internal + \brief Forward iterator on line graph window. + */ template <typename S, typename W, typename I> class graph_window_if_piter : public internal::site_relative_iterator_base< W, diff --git a/milena/mln/core/image/graph_window_piter.hh b/milena/mln/core/image/graph_window_piter.hh index ae86e8f..744e0bb 100644 --- a/milena/mln/core/image/graph_window_piter.hh +++ b/milena/mln/core/image/graph_window_piter.hh @@ -49,8 +49,11 @@ namespace mln namespace internal { - /// The window center and the window elements are part of - /// different site sets. + /*! + \internal + \brief The window center and the window elements are part of + different site sets. + */ template <typename C, typename P, typename E> struct impl_selector { @@ -63,8 +66,11 @@ namespace mln }; - /// The window center and the window elements are part of the same - /// site set. + /*! + \internal + \brief The window center and the window elements are part of the same + site set. + */ template <typename C, typename E> struct impl_selector<C,C,E> { @@ -89,12 +95,14 @@ namespace mln } // end of namespace mln::internal - /// Forward iterator on line graph window. - /// - /// \tparam S is the site set type. - /// \tparam W is the window type. - /// \tparam I is the underlying iterator type. - // + /*! + \internal + \brief Forward iterator on line graph window. + + \tparam S is the site set type. + \tparam W is the window type. + \tparam I is the underlying iterator type. + */ template <typename S, typename W, typename I> class graph_window_piter : public internal::site_relative_iterator_base< W, diff --git a/milena/mln/core/image/image1d.hh b/milena/mln/core/image/image1d.hh index 60f828d..701a0f5 100644 --- a/milena/mln/core/image/image1d.hh +++ b/milena/mln/core/image/image1d.hh @@ -58,7 +58,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::image1d<T>. + /*! + \internal + \brief Data structure for \c mln::image1d<T>. + */ template <typename T> struct data< image1d<T> > { diff --git a/milena/mln/core/image/image2d.hh b/milena/mln/core/image/image2d.hh index 213c7c9..31dc802 100644 --- a/milena/mln/core/image/image2d.hh +++ b/milena/mln/core/image/image2d.hh @@ -62,7 +62,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::image2d<T>. + /*! + \internal + \brief Data structure for \c mln::image2d<T>. + */ template <typename T> struct data< image2d<T> > { @@ -161,9 +164,13 @@ namespace mln image2d(const box2d& b, unsigned bdr = border::thickness); + /// @cond INTERNAL_API + /// Initialize an empty image. void init_(const box2d& b, unsigned bdr = border::thickness); + /// @endcond + /// Test if \p p is valid. bool has(const point2d& p) const; @@ -207,12 +214,17 @@ namespace mln // Specific methods: // ----------------- + /// @cond INTERNAL_API + /// Read-only access to the image value located at (\p row, \p col). const T& at_(mln::def::coord row, mln::def::coord col) const; /// Read-write access to the image value located at (\p row, \p col). T& at_(mln::def::coord row, mln::def::coord col); + /// @endcond + + /// Give the number of rows. unsigned nrows() const; @@ -251,8 +263,12 @@ namespace mln T* buffer(); + /// @cond INTERNAL_API + /// Resize image border with new_border. void resize_(unsigned new_border); + + /// @endcond }; diff --git a/milena/mln/core/image/image3d.hh b/milena/mln/core/image/image3d.hh index 9a4fabf..a5b6203 100644 --- a/milena/mln/core/image/image3d.hh +++ b/milena/mln/core/image/image3d.hh @@ -58,7 +58,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::image3d<T>. + /*! + \internal + \brief Data structure for \c mln::image3d<T>. + */ template <typename T> struct data< image3d<T> > { diff --git a/milena/mln/core/image/imorph/decorated_image.hh b/milena/mln/core/image/imorph/decorated_image.hh index ea0d767..0287940 100644 --- a/milena/mln/core/image/imorph/decorated_image.hh +++ b/milena/mln/core/image/imorph/decorated_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -59,7 +60,10 @@ namespace mln typedef mln::value::proxy<const E> lvalue; }; - /// Data structure for \c mln::decorated_image<I,D>. + /*! + \internal + \brief Data structure for \c mln::decorated_image<I,D>. + */ template <typename I, typename D> struct data< decorated_image<I,D> > { diff --git a/milena/mln/core/image/imorph/interpolated.hh b/milena/mln/core/image/imorph/interpolated.hh index 43f9a7e..d92dd0f 100644 --- a/milena/mln/core/image/imorph/interpolated.hh +++ b/milena/mln/core/image/imorph/interpolated.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -50,7 +50,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::interpolated<I, F>. + /*! + \internal + \brief Data structure for \c mln::interpolated<I, F>. + */ template <typename I, template <class> class F> struct data< interpolated<I,F> > { diff --git a/milena/mln/core/image/imorph/labeled_image.hh b/milena/mln/core/image/imorph/labeled_image.hh index c99f386..d62735f 100644 --- a/milena/mln/core/image/imorph/labeled_image.hh +++ b/milena/mln/core/image/imorph/labeled_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2009, 2010, 2011 EPITA Research and Development +// Copyright (C) 2009, 2010, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -62,7 +62,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::labeled_image<I>. + /*! + \internal + \brief Data structure for \c mln::labeled_image<I>. + */ template <typename I> struct data< labeled_image<I> > : data< labeled_image_base<I, labeled_image<I> > > diff --git a/milena/mln/core/image/imorph/lazy_image.hh b/milena/mln/core/image/imorph/lazy_image.hh index 0110bec..bcba84d 100644 --- a/milena/mln/core/image/imorph/lazy_image.hh +++ b/milena/mln/core/image/imorph/lazy_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -46,7 +47,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::lazy_image<I>. + /*! + \internal + \brief Data structure for \c mln::lazy_image<I>. + */ template <typename I, typename F, typename B> struct data< lazy_image<I,F,B> > { diff --git a/milena/mln/core/image/imorph/plain.hh b/milena/mln/core/image/imorph/plain.hh index 66c9ebd..8f862f4 100644 --- a/milena/mln/core/image/imorph/plain.hh +++ b/milena/mln/core/image/imorph/plain.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -47,7 +47,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::plain<I>. + /*! + \internal + \brief Data structure for \c mln::plain<I>. + */ template <typename I> struct data< plain<I> > { diff --git a/milena/mln/core/image/imorph/safe.hh b/milena/mln/core/image/imorph/safe.hh index c516ef4..37efd61 100644 --- a/milena/mln/core/image/imorph/safe.hh +++ b/milena/mln/core/image/imorph/safe.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -48,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::safe_image<I>. + /*! + \internal + \brief Data structure for \c mln::safe_image<I>. + */ template <typename I> struct data< safe_image<I> > { diff --git a/milena/mln/core/image/imorph/tr_image.hh b/milena/mln/core/image/imorph/tr_image.hh index 64eb5a0..ad2b1af 100644 --- a/milena/mln/core/image/imorph/tr_image.hh +++ b/milena/mln/core/image/imorph/tr_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -47,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::tr_image<S,I,T>. + /*! + \internal + \brief Data structure for \c mln::tr_image<S,I,T>. + */ template <typename S, typename I, typename T> struct data< tr_image<S,I,T> > { diff --git a/milena/mln/core/image/vertex_image.hh b/milena/mln/core/image/vertex_image.hh index d50f826..042423d 100644 --- a/milena/mln/core/image/vertex_image.hh +++ b/milena/mln/core/image/vertex_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -69,7 +70,10 @@ namespace mln namespace internal { - /// Data structure for mln::pw::internal::image + /*! + \internal + \brief Data structure for mln::pw::internal::image + */ template <typename P, typename V, typename G> struct data< mln::vertex_image<P,V,G> > { diff --git a/milena/mln/core/image/vmorph/cast_image.hh b/milena/mln/core/image/vmorph/cast_image.hh index 0226ad0..9d6248c 100644 --- a/milena/mln/core/image/vmorph/cast_image.hh +++ b/milena/mln/core/image/vmorph/cast_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2009, 2011 EPITA Research and Development +// Copyright (C) 2007, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -48,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::cast_image_<T,I>. + /*! + \internal + \brief Data structure for \c mln::cast_image_<T,I>. + */ template <typename T, typename I> struct data< cast_image_<T,I> > { diff --git a/milena/mln/core/image/vmorph/fun_image.hh b/milena/mln/core/image/vmorph/fun_image.hh index 9443198..66b2c1d 100644 --- a/milena/mln/core/image/vmorph/fun_image.hh +++ b/milena/mln/core/image/vmorph/fun_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -48,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::fun_image<T,I>. + /*! + \internal + \brief Data structure for \c mln::fun_image<T,I>. + */ template <typename F, typename I> struct data< fun_image<F,I> > { diff --git a/milena/mln/core/image/vmorph/thru_image.hh b/milena/mln/core/image/vmorph/thru_image.hh index e829b27..7dd4d7a 100644 --- a/milena/mln/core/image/vmorph/thru_image.hh +++ b/milena/mln/core/image/vmorph/thru_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -50,7 +50,10 @@ namespace mln template <typename I, typename F> class thru_image_write; template <typename I, typename F> class thru_image_read; - /// Find correct implementation + /*! + \internal + \brief Find correct implementation + */ template <typename I, typename F> struct thru_find_impl { @@ -63,7 +66,10 @@ namespace mln write, read) ret; }; - /// Data structure for \c mln::thru_image<I>. + /*! + \internal + \brief Data structure for \c mln::thru_image<I>. + */ template <typename I, typename F> struct data< thru_image<I, F> > { diff --git a/milena/mln/core/image/vmorph/violent_cast_image.hh b/milena/mln/core/image/vmorph/violent_cast_image.hh index 0ce4669..e389902 100644 --- a/milena/mln/core/image/vmorph/violent_cast_image.hh +++ b/milena/mln/core/image/vmorph/violent_cast_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -45,7 +45,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::violent_cast_image<T,I>. + /*! + \internal + \brief Data structure for \c mln::violent_cast_image<T,I>. + */ template <typename T, typename I> struct data< violent_cast_image<T,I> > { diff --git a/milena/mln/core/internal/box_impl.hh b/milena/mln/core/internal/box_impl.hh index bb176c7..3ea2756 100644 --- a/milena/mln/core/internal/box_impl.hh +++ b/milena/mln/core/internal/box_impl.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -46,10 +46,12 @@ namespace mln // box_impl - /*! Implementation class to equip objects having a bounding - * box. - * - */ + /*! + \internal + \brief Implementation class to equip objects having a bounding + box. + + */ template <unsigned n, typename C, typename E> struct box_impl_; diff --git a/milena/mln/core/internal/check/image_fastest.hh b/milena/mln/core/internal/check/image_fastest.hh index 95ab8a9..debece7 100644 --- a/milena/mln/core/internal/check/image_fastest.hh +++ b/milena/mln/core/internal/check/image_fastest.hh @@ -50,7 +50,10 @@ namespace mln namespace check { - /// FIXME + /*! + \internal + \brief Statically checks the interface of fastest images. + */ template < typename E, typename B = metal::true_ > struct image_fastest_ { diff --git a/milena/mln/core/internal/classical_window_base.hh b/milena/mln/core/internal/classical_window_base.hh index a701510..21f68c3 100644 --- a/milena/mln/core/internal/classical_window_base.hh +++ b/milena/mln/core/internal/classical_window_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -47,8 +48,9 @@ namespace mln namespace internal { - /*! FIXME. - * + /*! + \internal + \brief Base class for classes based on a set of dpoints. */ template <typename D, typename E> class classical_window_base : public window_base<D, E> diff --git a/milena/mln/core/internal/complex_neighborhood_base.hh b/milena/mln/core/internal/complex_neighborhood_base.hh index d71dec9..4ffd8a0 100644 --- a/milena/mln/core/internal/complex_neighborhood_base.hh +++ b/milena/mln/core/internal/complex_neighborhood_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -55,11 +56,14 @@ namespace mln namespace internal { - /** \brief Generic neighborhood centered on the face of a complex, - based on an pair of (forward and backward) complex iterators. - - \tparam W The underlying window. - \tparam E The exact type. */ + /*! + \internal + \brief Generic neighborhood centered on the face of a complex, + based on an pair of (forward and backward) complex iterators. + + \tparam W The underlying window. + \tparam E The exact type. + */ template <typename W, typename E> class complex_neighborhood_base : public Neighborhood<E> { diff --git a/milena/mln/core/internal/complex_window_base.hh b/milena/mln/core/internal/complex_window_base.hh index 1a248a0..eeb62fd 100644 --- a/milena/mln/core/internal/complex_window_base.hh +++ b/milena/mln/core/internal/complex_window_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -70,15 +71,18 @@ namespace mln namespace internal { - /** \brief Generic window centered on the face of a complex, based - on an pair of (forward and backward) complex iterators. The - center (site) is part of the window. - - \tparam D The dimension of the complex. - \tparam G The type of the geometry functor of the complex. - \tparam F The underlying forward iterator type. - \tparam B The underlying backward iterator type. - \tparam E The exact type. */ + /*! + \internal + \brief Generic window centered on the face of a complex, based + on an pair of (forward and backward) complex iterators. The + center (site) is part of the window. + + \tparam D The dimension of the complex. + \tparam G The type of the geometry functor of the complex. + \tparam F The underlying forward iterator type. + \tparam B The underlying backward iterator type. + \tparam E The exact type. + */ template <unsigned D, typename G, typename F, typename B, typename E> class complex_window_base : public Window<E> { diff --git a/milena/mln/core/internal/complex_window_p_base.hh b/milena/mln/core/internal/complex_window_p_base.hh index 65e79e9..55de131 100644 --- a/milena/mln/core/internal/complex_window_p_base.hh +++ b/milena/mln/core/internal/complex_window_p_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -65,15 +66,18 @@ namespace mln namespace internal { - /** \brief Generic window centered on the face of a complex, based - on an pair of (forward and backward) complex iterators. The - center (site) is part of the window. - - \tparam D The dimension of the complex. - \tparam G The type of the geometry functor of the complex. - \tparam F The underlying forward iterator type. - \tparam B The underlying backward iterator type. - \tparam E The exact type. */ + /*! + \internal + \brief Generic window centered on the face of a complex, based + on an pair of (forward and backward) complex iterators. The + center (site) is part of the window. + + \tparam D The dimension of the complex. + \tparam G The type of the geometry functor of the complex. + \tparam F The underlying forward iterator type. + \tparam B The underlying backward iterator type. + \tparam E The exact type. + */ template <unsigned D, typename G, typename F, typename B, typename E> class complex_window_p_base : public complex_window_base diff --git a/milena/mln/core/internal/fixme.hh b/milena/mln/core/internal/fixme.hh index 819a926..10622c5 100644 --- a/milena/mln/core/internal/fixme.hh +++ b/milena/mln/core/internal/fixme.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -38,10 +39,11 @@ namespace mln namespace internal { - /*! A FIXME class to make explicit in code that a type is - * not yet implemented. - * - */ + /*! + \internal + \brief A FIXME class to make explicit in code that a type is + not yet implemented. + */ struct fixme {}; diff --git a/milena/mln/core/internal/graph_psite_base.hh b/milena/mln/core/internal/graph_psite_base.hh index cb3b123..4cef358 100644 --- a/milena/mln/core/internal/graph_psite_base.hh +++ b/milena/mln/core/internal/graph_psite_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -159,7 +159,10 @@ namespace mln /// \{ - /// subject_impl specialization (Proxy) + /*! + \internal + \brief subject_impl specialization (Proxy) + */ template <typename S, typename P, typename E> struct subject_impl< const graph_psite_base<S,P>&, E > { diff --git a/milena/mln/core/internal/graph_window_base.hh b/milena/mln/core/internal/graph_window_base.hh index cb7baa3..335a32e 100644 --- a/milena/mln/core/internal/graph_window_base.hh +++ b/milena/mln/core/internal/graph_window_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -35,7 +36,12 @@ namespace mln { - /// \tparam P Site type. + /*! + \internal + \brief Base class for windows on graphes. + + \tparam P Site type. + */ template <typename P, typename E> class graph_window_base : public Window<E> { diff --git a/milena/mln/core/internal/image_base.hh b/milena/mln/core/internal/image_base.hh index c9f76de..c810547 100644 --- a/milena/mln/core/internal/image_base.hh +++ b/milena/mln/core/internal/image_base.hh @@ -146,18 +146,25 @@ namespace mln /// Copy constructor (performs a shallow copy). image_base(const image_base& rhs); - /// Give an identifier of this image. When several image - /// variables designate the same image, they share the same - /// identifier. + /// @cond INTERNAL_API + + /*! + \brief Give an identifier of this image. + + When several image variables designate the same image, they + share the same identifier. + */ const void* id_() const; + /// \brief Hook to the image data. + const util::tracked_ptr< internal::data<E> >& hook_data_() const; + + /// @endcond + /// Detach data from an image (free it if nobody else hold it). void destroy(); - /// Hook to the image data. - const util::tracked_ptr< internal::data<E> >& hook_data_() const; - protected: /// Constructor without argument. diff --git a/milena/mln/core/internal/image_domain_morpher.hh b/milena/mln/core/internal/image_domain_morpher.hh index 576574e..2a2aa1e 100644 --- a/milena/mln/core/internal/image_domain_morpher.hh +++ b/milena/mln/core/internal/image_domain_morpher.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,13 +41,15 @@ namespace mln { - /*! A base class for image morphers w.r.t. domain. - * - * Parameter \p I is the morphed image type. - * Parameter \p S is the morpher site set type. - * Parameter \p E is the exact (morpher image) type. - * - */ + /*! + \internal + \brief A base class for image morphers w.r.t. domain. + + Parameter \p I is the morphed image type. + Parameter \p S is the morpher site set type. + Parameter \p E is the exact (morpher image) type. + + */ template <typename I, typename S, typename E> class image_domain_morpher : public image_morpher<I, mln_value(I), S, E> { diff --git a/milena/mln/core/internal/image_identity.hh b/milena/mln/core/internal/image_identity.hh index 25e8b3a..a5055f6 100644 --- a/milena/mln/core/internal/image_identity.hh +++ b/milena/mln/core/internal/image_identity.hh @@ -120,10 +120,13 @@ namespace mln - /*! A base class for image morphers w.r.t. identity. - * Parameter \p S is a point set type. - * - */ + /*! + \internal + \brief A base class for image morphers w.r.t. identity. + + Parameter \p S is a point set type. + + */ template <typename I, typename S, typename E> class image_identity : public image_identity_impl<I, E>, diff --git a/milena/mln/core/internal/image_morpher.hh b/milena/mln/core/internal/image_morpher.hh index 288e6a2..579230a 100644 --- a/milena/mln/core/internal/image_morpher.hh +++ b/milena/mln/core/internal/image_morpher.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -44,10 +45,12 @@ namespace mln namespace internal { - /// A base class for images that are morphers. Parameter - /// - /// \c I is the underlying-morphed image type. - // + /*! + \internal + \brief A base class for images that are morphers. + + Parameter \c I is the underlying-morphed image type. + */ template <typename I, typename T, typename S, typename E> class image_morpher : public image_base<T, S, E> { diff --git a/milena/mln/core/internal/image_primary.hh b/milena/mln/core/internal/image_primary.hh index 58f9065..6e9dbea 100644 --- a/milena/mln/core/internal/image_primary.hh +++ b/milena/mln/core/internal/image_primary.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,9 +42,10 @@ namespace mln { - /*! A base class for primary images. - * - */ + /*! + \internal + \brief A base class for primary images. + */ template <typename T, typename S, typename E> struct image_primary : public image_base<T, S, E> { diff --git a/milena/mln/core/internal/image_value_morpher.hh b/milena/mln/core/internal/image_value_morpher.hh index b7f7c41..8329242 100644 --- a/milena/mln/core/internal/image_value_morpher.hh +++ b/milena/mln/core/internal/image_value_morpher.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,10 +46,13 @@ namespace mln //FIXME: Fix doxygen. - /*! A base class for image morphers w.r.t. value. - * Parameter \p S is a point set type. - * Parameter \p P is a value type. - */ + /*! + \internal + \brief A base class for image morphers w.r.t. value. + + Parameter \p S is a point set type. + Parameter \p P is a value type. + */ template <typename I, typename T, typename E> class image_value_morpher : public image_morpher<I, T, mln_domain(I), E> { diff --git a/milena/mln/core/internal/is_masked_impl_selector.hh b/milena/mln/core/internal/is_masked_impl_selector.hh index 41d941b..361d85e 100644 --- a/milena/mln/core/internal/is_masked_impl_selector.hh +++ b/milena/mln/core/internal/is_masked_impl_selector.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2011, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -46,8 +46,11 @@ namespace mln namespace internal { - /// Default implementation. D == S. - /// D and S are site sets. + /*! + \internal + \brief Default implementation. D == S. + D and S are site sets. + */ template <typename S, typename D, typename E> struct is_masked_impl_selector { @@ -56,7 +59,10 @@ namespace mln const mln_graph_element(S)& element) const; }; - /// Restrict iteration on vertices according to masked edges. + /*! + \internal + \brief Restrict iteration on vertices according to masked edges. + */ template <typename G1, typename F1, typename G2, typename F2, typename E> struct is_masked_impl_selector< p_vertices<G1,F1>, p_edges<G2,F2>, E > { @@ -67,7 +73,10 @@ namespace mln const mln_graph_element(S)& element) const; }; - /// Restrict iteration on edges according to masked vertices. + /*! + \internal + \brief Restrict iteration on edges according to masked vertices. + */ template <typename G1, typename F1, typename G2, typename F2, typename E> struct is_masked_impl_selector< p_edges<G1,F1>, p_vertices<G2,F2>, E > { diff --git a/milena/mln/core/internal/labeled_image_base.hh b/milena/mln/core/internal/labeled_image_base.hh index 45f3ed2..9c9466c 100644 --- a/milena/mln/core/internal/labeled_image_base.hh +++ b/milena/mln/core/internal/labeled_image_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2010, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -60,7 +60,10 @@ namespace mln namespace internal { - /// Data structure for \c mln::labeled_image_base<I,E>. + /*! + \internal + \brief Data structure for \c mln::labeled_image_base<I,E>. + */ template <typename I, typename E> struct data< labeled_image_base<I,E> > { @@ -100,17 +103,18 @@ namespace mln - /*! \brief Base class Morpher providing an improved interface for - labeled image. + /*! + \internal + \brief Base class Morpher providing an improved interface for + labeled image. - \tparam I The label image type. + \tparam I The label image type. - This image type allows to access every site set at a given - label. - - This image type guaranties that labels are contiguous (from 1 to - n). + This image type allows to access every site set at a given + label. + This image type guaranties that labels are contiguous (from 1 to + n). */ template <typename I, typename E> class labeled_image_base diff --git a/milena/mln/core/internal/morpher_lvalue.hh b/milena/mln/core/internal/morpher_lvalue.hh index d851e55..e437fa1 100644 --- a/milena/mln/core/internal/morpher_lvalue.hh +++ b/milena/mln/core/internal/morpher_lvalue.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -44,8 +45,11 @@ namespace mln namespace internal { - /// Return the lvalue type when an image with type \c I - /// is morphed. + /*! + \internal + \brief Return the lvalue type when an image with type \c I + is morphed. + */ template <typename I> struct morpher_lvalue_ { diff --git a/milena/mln/core/internal/neighb_base.hh b/milena/mln/core/internal/neighb_base.hh index bfb499a..05d4b67 100644 --- a/milena/mln/core/internal/neighb_base.hh +++ b/milena/mln/core/internal/neighb_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -42,11 +43,13 @@ namespace mln { - /// Adapter class from window to neighborhood. - /// - /// \tparam W The underlying window type. - /// \tparam E The exact neighborhood type. - // + /*! + \internal + \brief Adapter class from window to neighborhood. + + \tparam W The underlying window type. + \tparam E The exact neighborhood type. + */ template <typename W, typename E> class neighb_base : public internal::neighborhood_base< W, E >, diff --git a/milena/mln/core/internal/neighb_niter_base.hh b/milena/mln/core/internal/neighb_niter_base.hh index 27459b6..daa41db 100644 --- a/milena/mln/core/internal/neighb_niter_base.hh +++ b/milena/mln/core/internal/neighb_niter_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -39,8 +40,10 @@ namespace mln namespace internal { - // neighb_niter_base<W,I,E> - + /*! + \internal + \brief Base implementation for neighborhood iterators. + */ template <typename W, typename N, typename I, typename E> class neighb_niter_base : public internal::site_relative_iterator_base< N, diff --git a/milena/mln/core/internal/neighb_niter_impl.hh b/milena/mln/core/internal/neighb_niter_impl.hh index f2c8ee0..eb5b6d2 100644 --- a/milena/mln/core/internal/neighb_niter_impl.hh +++ b/milena/mln/core/internal/neighb_niter_impl.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -54,25 +54,31 @@ namespace mln namespace internal { - /// Default optional implementation. + /*! + \internal + \brief Default optional implementation. + */ template <typename W, typename E> struct neighb_niter_impl { }; - /// Add more implementation for neighborhoods made from - /// graph_window_base windows. - /// - /// FIXME: we need to redeclare the graph element interface. - /// Here, a neighb niter iterator encapsulates a window qiter iterator. - /// A window qiter iterator is a Proxy on a site P and can convert towards - /// a graph element through its member element(). - /// - /// The window qiter iterator cannot have an automatic conversion towards - /// a graph element since there would be an ambiguity between this - /// conversion and the conversion to a psite P, if P is also a graph - /// element. + /*! + \internal + \brief Add more implementation for neighborhoods made from + graph_window_base windows. + + FIXME: we need to redeclare the graph element interface. + Here, a neighb niter iterator encapsulates a window qiter iterator. + A window qiter iterator is a Proxy on a site P and can convert towards + a graph element through its member element(). + + The window qiter iterator cannot have an automatic conversion towards + a graph element since there would be an ambiguity between this + conversion and the conversion to a psite P, if P is also a graph + element. + */ template <typename P, typename E> struct neighb_niter_impl_graph_window { @@ -83,29 +89,38 @@ namespace mln }; - /// In this case, The site P is a util::vertex which means this iterator - /// can automatically converts towards this type. - /// There would be an ambiguity between util::vertex members and the one - /// declared in neighb_niter_impl_graph_window<P,E> if this - /// specialization did not exist. + /*! + \internal + In this case, The site P is a util::vertex which means this iterator + can automatically converts towards this type. + There would be an ambiguity between util::vertex members and the one + declared in neighb_niter_impl_graph_window<P,E> if this + specialization did not exist. + */ template <typename G, typename E> struct neighb_niter_impl_graph_window< util::vertex<G>, E > { }; - /// In this case, The site P is a util::vertex which means this iterator - /// can automatically converts towards this type. - /// There would be an ambiguity between util::edge members and the one - /// declared in neighb_niter_impl_graph_window<P,E> if this - /// specialization did not exist. + /*! + \internal + In this case, The site P is a util::vertex which means this iterator + can automatically converts towards this type. + There would be an ambiguity between util::edge members and the one + declared in neighb_niter_impl_graph_window<P,E> if this + specialization did not exist. + */ template <typename G, typename E> struct neighb_niter_impl_graph_window< util::edge<G>, E > { }; - /// Add more implementation for neighborhoods made from - /// graph_window_base windows. + /*! + \internal + \brief Add more implementation for neighborhoods made from + graph_window_base windows. + */ template <typename P, typename T, typename E> struct neighb_niter_impl< graph_window_base<P, T>, E > : neighb_niter_impl_graph_window<P,E> @@ -124,8 +139,11 @@ namespace mln - /// Add more implementation for neighborhoods made from a - /// graph_window_piter. + /*! + \internal + \brief Add more implementation for neighborhoods made from a + graph_window_piter. + */ template <typename G, typename S, typename E> struct neighb_niter_impl<graph_elt_window<G,S>, E> : public neighb_niter_impl< graph_window_base< mln_result(S::fun_t), @@ -135,8 +153,11 @@ namespace mln }; - /// Add more implementation for neighborhoods made from a - /// line_graph_window_piter. + /*! + \internal + \brief Add more implementation for neighborhoods made from a + line_graph_window_piter. + */ template <typename G, typename F, typename E> struct neighb_niter_impl<line_graph_elt_window<G,F>, E> : public neighb_niter_impl< graph_window_base< mln_result(F), @@ -147,8 +168,11 @@ namespace mln }; - /// Add more implementation for neighborhoods made from a - /// graph_window_if_piter. + /*! + \internal + \brief Add more implementation for neighborhoods made from a + graph_window_if_piter. + */ template <typename G, typename S, typename I, typename E> struct neighb_niter_impl<graph_elt_window_if<G,S,I>, E> : public neighb_niter_impl< graph_window_base< mln_result(S::fun_t), @@ -159,8 +183,11 @@ namespace mln }; - /// Add more implementation for neighborhoods made from a - /// graph_window_piter. + /*! + \internal + \brief Add more implementation for neighborhoods made from a + graph_window_piter. + */ template <typename G, typename S, typename S2, typename E> struct neighb_niter_impl<graph_elt_mixed_window<G,S,S2>, E> : public neighb_niter_impl< graph_window_base< mln_result(S2::fun_t), diff --git a/milena/mln/core/internal/neighborhood_base.hh b/milena/mln/core/internal/neighborhood_base.hh index f96b8f4..fb0a6e9 100644 --- a/milena/mln/core/internal/neighborhood_base.hh +++ b/milena/mln/core/internal/neighborhood_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -112,10 +113,12 @@ namespace mln }; - /// Base class for neighborhood implementation classes. - /// - /// \p W is the underlying window type. + /*! + \internal + \base Base class for neighborhood implementation classes. + \p W is the underlying window type. + */ template <typename W, typename E> struct neighborhood_base : public neighborhood_impl<W,E> { diff --git a/milena/mln/core/internal/piter_adaptor.hh b/milena/mln/core/internal/piter_adaptor.hh index 41c6333..fa84a43 100644 --- a/milena/mln/core/internal/piter_adaptor.hh +++ b/milena/mln/core/internal/piter_adaptor.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -44,11 +45,13 @@ namespace mln namespace internal { - /// A base class for point iterator adaptors. - /// - /// Parameter \c Pi is the type of the point iterator adaptee; - /// parameter E is the exact type. - /// + /*! + \internal + \brief A base class for point iterator adaptors. + + Parameter \c Pi is the type of the point iterator adaptee; + parameter E is the exact type. + */ template <typename Pi, typename S, typename E> class piter_adaptor_ : public internal::site_iterator_base< S, E > { diff --git a/milena/mln/core/internal/piter_identity.hh b/milena/mln/core/internal/piter_identity.hh index 00fb16d..e0549f7 100644 --- a/milena/mln/core/internal/piter_identity.hh +++ b/milena/mln/core/internal/piter_identity.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -39,11 +40,13 @@ namespace mln namespace internal { - /// A base class for site iterator identity adaptors. - /// - /// Parameter \c Pi is the type of the site iterator adaptee; - /// parameter E is the exact type. - /// + /*! + \internal + \brief A base class for site iterator identity adaptors. + + Parameter \c Pi is the type of the site iterator adaptee; + parameter E is the exact type. + */ template <typename Pi, typename E> class piter_identity_ : public piter_adaptor_< Pi, // Adaptee. mln_pset(Pi), // Site set. diff --git a/milena/mln/core/internal/pixel_impl.hh b/milena/mln/core/internal/pixel_impl.hh index a07f677..96d94e0 100644 --- a/milena/mln/core/internal/pixel_impl.hh +++ b/milena/mln/core/internal/pixel_impl.hh @@ -109,9 +109,11 @@ namespace mln }; - /// Implementation class to equip generalized pixel - /// classes based on mutable images. - /// + /*! + \internal + \brief Implementation class to equip generalized pixel + classes based on mutable images. + */ template <typename I, typename E> class pixel_impl_ @@ -168,9 +170,11 @@ namespace mln }; - /// Implementation class to equip generalized pixel - /// classes based on constant images. - /// + /*! + \internal + \brief Implementation class to equip generalized pixel + classes based on constant images. + */ template <typename I, typename E> class pixel_impl_< const I, E > diff --git a/milena/mln/core/internal/pixel_iterator_base.hh b/milena/mln/core/internal/pixel_iterator_base.hh index 5e8107e..7f3b6ce 100644 --- a/milena/mln/core/internal/pixel_iterator_base.hh +++ b/milena/mln/core/internal/pixel_iterator_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,7 +46,10 @@ namespace mln | internal::pixel_iterator_base_<I, E>. | `---------------------------------------*/ - /// A base class for pixel iterators. + /*! + \internal + \brief A base class for pixel iterators. + */ template <typename I, typename E> class pixel_iterator_base_ : public Pixel_Iterator<E>, public internal::pixel_impl_<I, E> @@ -73,7 +77,10 @@ namespace mln | internal::forward_pixel_iterator_base_<I, E>. | `-----------------------------------------------*/ - /// A base class for forward pixel iterators. + /*! + \internal + \brief A base class for forward pixel iterators. + */ template <typename I, typename E> class forward_pixel_iterator_base_ : public pixel_iterator_base_<I, E> { @@ -102,7 +109,10 @@ namespace mln | internal::backward_pixel_iterator_base_<I, E>. | `------------------------------------------------*/ - /// A base class for backward pixel iterators. + /*! + \internal + \brief A base class for backward pixel iterators. + */ template <typename I, typename E> class backward_pixel_iterator_base_ : public pixel_iterator_base_<I, E> { diff --git a/milena/mln/core/internal/pseudo_site_base.hh b/milena/mln/core/internal/pseudo_site_base.hh index da61277..576428e 100644 --- a/milena/mln/core/internal/pseudo_site_base.hh +++ b/milena/mln/core/internal/pseudo_site_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,10 +41,12 @@ namespace mln namespace internal { - /*! A base class for pseudo sites. - * - * Parameter \c P is FIXME: a point site type. - */ + /*! + \internal + \brief A base class for pseudo sites. + + Parameter \c P is FIXME: a point site type. + */ template <typename P, typename E> struct pseudo_site_base_ : Pseudo_Site<E>, proxy_impl<P, E> diff --git a/milena/mln/core/internal/run_image.hh b/milena/mln/core/internal/run_image.hh index da12ad8..1751b1b 100644 --- a/milena/mln/core/internal/run_image.hh +++ b/milena/mln/core/internal/run_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,11 +42,14 @@ namespace mln namespace internal { - /*! Factorization class for run_image. - * Parameter \c T is the type of the image value. - * Parameter \c P is the type of the image point. - * Parameter \c E is the Exact type of the image. - */ + /*! + \internal + \brief Factorization class for run_image. + + Parameter \c T is the type of the image value. + Parameter \c P is the type of the image point. + Parameter \c E is the Exact type of the image. + */ template <typename T, typename P, typename E> class run_image_ : public internal::image_primary< P, p_set_of< p_run<P> >, E > { diff --git a/milena/mln/core/internal/set_of.hh b/milena/mln/core/internal/set_of.hh index df8568b..f4d4bed 100644 --- a/milena/mln/core/internal/set_of.hh +++ b/milena/mln/core/internal/set_of.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,16 +46,19 @@ namespace mln namespace internal { - /*! An "efficient" mathematical set class. - * This set class is designed to store a mathematical set and to - * present it to the user as a linear array (std::vector). - * Elements are stored by copy. Implementation is lazy. - * \invariant \a v_.size() == s_.size() - * The parameter \c E is the element type, which shall not be - * const-qualified. - * - * \todo Add a remove method. - */ + /*! + \internal + \brief An "efficient" mathematical set class. + + This set class is designed to store a mathematical set and to + present it to the user as a linear array (std::vector). + Elements are stored by copy. Implementation is lazy. + \invariant \a v_.size() == s_.size() + The parameter \c E is the element type, which shall not be + const-qualified. + + \todo Add a remove method. + */ template <typename E> class set_of_ { diff --git a/milena/mln/core/internal/site_relative_iterator_base.hh b/milena/mln/core/internal/site_relative_iterator_base.hh index 7483dfa..c091203 100644 --- a/milena/mln/core/internal/site_relative_iterator_base.hh +++ b/milena/mln/core/internal/site_relative_iterator_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -47,16 +47,18 @@ namespace mln namespace internal { - /// A generic iterator on points of windows and of - /// neighborhoods. - /// - /// Parameter \c S is the targeted "site set definition" type. It - /// can be either a Window, or a Neighborhood. - /// - /// IMPORTANT: Sub-classes have to define center_at_, do_start_, do_next_, - /// is_valid_, invalidate_ and compute_p_. They shall define - /// NEITHER start_ NOR next_. - /// + /*! + \internal + \brief A generic iterator on points of windows and of + neighborhoods. + + Parameter \c S is the targeted "site set definition" type. It + can be either a Window, or a Neighborhood. + + IMPORTANT: Sub-classes have to define center_at_, do_start_, do_next_, + is_valid_, invalidate_ and compute_p_. They shall define + NEITHER start_ NOR next_. + */ template <typename S, typename E, typename C = mln_psite(S)> class site_relative_iterator_base : public site_iterator_base< S, E > { diff --git a/milena/mln/core/internal/site_set_base.hh b/milena/mln/core/internal/site_set_base.hh index 076d480..191a16c 100644 --- a/milena/mln/core/internal/site_set_base.hh +++ b/milena/mln/core/internal/site_set_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -42,12 +43,15 @@ namespace mln { - /// A base class for site set classes. - /// - /// \tparam P The psite type of what is ``contained'' in the site - /// set, not the psite of the site set (which is - /// different, and defined by the site set itself). - /// \tparam E The exact type of the site set. + /*! + \internal + \brief A base class for site set classes. + + \tparam P The psite type of what is ``contained'' in the site + set, not the psite of the site set (which is + different, and defined by the site set itself). + \tparam E The exact type of the site set. + */ template <typename P, typename E> struct site_set_base_ : public Site_Set<E> { diff --git a/milena/mln/core/internal/site_set_iterator_base.hh b/milena/mln/core/internal/site_set_iterator_base.hh index 71c3fe3..0b85fbb 100644 --- a/milena/mln/core/internal/site_set_iterator_base.hh +++ b/milena/mln/core/internal/site_set_iterator_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -41,14 +41,16 @@ namespace mln namespace internal { - /// A base class for iterators on site sets. - /// - /// Parameter \c S is the targeted site set type. - /// - /// IMPORTANT: Sub-classes have to define start_, next_, - /// is_valid_ and invalidate_. They may also define - /// change_target_. - // + /*! + \internal + \brief A base class for iterators on site sets. + + Parameter \c S is the targeted site set type. + + IMPORTANT: Sub-classes have to define start_, next_, + is_valid_ and invalidate_. They may also define + change_target_. + */ template <typename S, typename E> class site_set_iterator_base : public site_iterator_base<S, E> { diff --git a/milena/mln/core/internal/weighted_window_base.hh b/milena/mln/core/internal/weighted_window_base.hh index cb21536..4a6698c 100644 --- a/milena/mln/core/internal/weighted_window_base.hh +++ b/milena/mln/core/internal/weighted_window_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -39,10 +40,12 @@ namespace mln namespace internal { - /// Base class for weighted window classes. - /// - /// \p W is the corresponding window type. + /*! + \internal + \brief Base class for weighted window classes. + \p W is the corresponding window type. + */ template <typename W, typename E> struct weighted_window_base : public Weighted_Window<E> { @@ -70,7 +73,7 @@ namespace mln /// method is valid iff the support is regular and the /// definition is not varying. bool is_centered() const; - + /// Give the maximum coordinate gap; final method. This method /// is valid iff the support is regular and the definition is /// not varying. diff --git a/milena/mln/core/internal/window_base.hh b/milena/mln/core/internal/window_base.hh index 0047055..bfe8da5 100644 --- a/milena/mln/core/internal/window_base.hh +++ b/milena/mln/core/internal/window_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,10 +41,12 @@ namespace mln { - /// A base class for window classes. - /// - /// \p D is a dpsite type. - /// + /*! + \internal + \brief A base class for window classes. + + \p D is a dpsite type. + */ template <typename D, typename E> struct window_base : public Window<E> { diff --git a/milena/mln/core/pixter1d.hh b/milena/mln/core/pixter1d.hh index da0eb75..8a626da 100644 --- a/milena/mln/core/pixter1d.hh +++ b/milena/mln/core/pixter1d.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,7 +41,10 @@ namespace mln | fwd_pixter1d<I>. | `------------------*/ - /// Forward pixel iterator on a 1-D image with border. + /*! + \internal + \brief Forward pixel iterator on a 1-D image with border. + */ template <typename I> class fwd_pixter1d : public internal::forward_pixel_iterator_base_< I, fwd_pixter1d<I> > @@ -64,7 +68,10 @@ namespace mln | bkd_pixter1d<I>. | `------------------*/ - /// Backward pixel iterator on a 1-D image with border. + /*! + \internal + \brief Backward pixel iterator on a 1-D image with border. + */ template <typename I> class bkd_pixter1d : public internal::backward_pixel_iterator_base_< I, bkd_pixter1d<I> > diff --git a/milena/mln/core/pixter2d.hh b/milena/mln/core/pixter2d.hh index 930addd..49011aa 100644 --- a/milena/mln/core/pixter2d.hh +++ b/milena/mln/core/pixter2d.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -42,7 +43,10 @@ namespace mln | fwd_pixter2d<I>. | `------------------*/ - /// Forward pixel iterator on a 2-D image with border. + /*! + \internal + \brief Forward pixel iterator on a 2-D image with border. + */ template <typename I> class fwd_pixter2d : public internal::forward_pixel_iterator_base_< I, fwd_pixter2d<I> > @@ -82,7 +86,10 @@ namespace mln | bkd_pixter2d<I>. | `------------------*/ - /// Backward pixel iterator on a 2-D image with border. + /*! + \internal + \brief Backward pixel iterator on a 2-D image with border. + */ template <typename I> class bkd_pixter2d : public internal::backward_pixel_iterator_base_< I, bkd_pixter2d<I> > diff --git a/milena/mln/core/pixter3d.hh b/milena/mln/core/pixter3d.hh index a9cb48b..93bad74 100644 --- a/milena/mln/core/pixter3d.hh +++ b/milena/mln/core/pixter3d.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +44,10 @@ namespace mln | fwd_pixter3d<I>. | `------------------*/ - /// Forward pixel iterator on a 3-D image with border. + /*! + \internal + \brief Forward pixel iterator on a 3-D image with border. + */ template <typename I> class fwd_pixter3d : public internal::forward_pixel_iterator_base_< I, fwd_pixter3d<I> > @@ -95,7 +99,10 @@ namespace mln | bkd_pixter3d<I>. | `------------------*/ - /// Backward pixel iterator on a 3-D image with border. + /*! + \internal + \brief Backward pixel iterator on a 3-D image with border. + */ template <typename I> class bkd_pixter3d : public internal::backward_pixel_iterator_base_< I, bkd_pixter3d<I> > diff --git a/milena/mln/core/routine/ops.hh b/milena/mln/core/routine/ops.hh index db26631..220e14d 100644 --- a/milena/mln/core/routine/ops.hh +++ b/milena/mln/core/routine/ops.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -107,27 +107,45 @@ namespace mln // For unary operators. - /// Default definition of op::uplus trait. + /*! + \internal + \brief Default definition of op::uplus trait. + */ template <typename O> struct set_unary_< op::uplus, Object,O > { typedef O ret; }; - /// Default definition of op::uminus trait. + /*! + \internal + \brief Default definition of op::uminus trait. + */ template <typename O> struct set_unary_< op::uminus, Object,O > { typedef mln_trait_op_minus(O, O) ret; }; - /// Default definition of op::preinc trait. + /*! + \internal + \brief Default definition of op::preinc trait. + */ template <typename O> struct set_unary_< op::preinc, Object,O > { typedef O& ret; }; - /// Default definition of op::preinc trait. + /*! + \internal + \brief Default definition of op::preinc trait. + */ template <typename O> struct set_unary_< op::predec, Object,O > { typedef O& ret; }; - /// Default definition of op::postinc trait. + /*! + \internal + \brief Default definition of op::postinc trait. + */ template <typename O> struct set_unary_< op::postinc, Object,O > { typedef O ret; }; - /// Default definition of op::postinc trait. + /*! + \internal + \brief Default definition of op::postinc trait. + */ template <typename O> struct set_unary_< op::postdec, Object,O > { typedef O ret; }; diff --git a/milena/mln/core/site_set/attic/p_complex_faces_piter.hh b/milena/mln/core/site_set/attic/p_complex_faces_piter.hh index d910b4f..1f01319 100644 --- a/milena/mln/core/site_set/attic/p_complex_faces_piter.hh +++ b/milena/mln/core/site_set/attic/p_complex_faces_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -55,8 +56,11 @@ namespace mln | p_complex_faces_fwd_piter_<N, D, P>. | `--------------------------------------*/ - /// \brief Forward iterator on the \p N-faces sites of an - /// mln::p_complex<D, P>. + /*! + \internal + \brief Forward iterator on the \p N-faces sites of an + mln::p_complex<D, P>. + */ template <unsigned N, unsigned D, typename P> class p_complex_faces_fwd_piter_ : public internal::p_complex_piter_base_< topo::faces_fwd_iter_<N, D>, @@ -83,8 +87,11 @@ namespace mln | p_complex_faces_bkd_piter_<N, D, P>. | `--------------------------------------*/ - /// \brief Backward iterator on the \p N-faces sites of an - /// mln::p_complex<D, P>. + /*! + \internal + \brief Backward iterator on the \p N-faces sites of an + mln::p_complex<D, P>. + */ template <unsigned N, unsigned D, typename P> class p_complex_faces_bkd_piter_ /* FIXME: Rename internal::p_complex_piter_base_ to something else, diff --git a/milena/mln/core/site_set/attic/p_faces_piter.hh b/milena/mln/core/site_set/attic/p_faces_piter.hh index 148872c..7f67bbc 100644 --- a/milena/mln/core/site_set/attic/p_faces_piter.hh +++ b/milena/mln/core/site_set/attic/p_faces_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -51,8 +52,11 @@ namespace mln | p_faces_fwd_piter_<N, D, P>. | `------------------------------*/ - /// \brief Forward iterator on the \p N-faces sites of an - /// mln::p_faces<N, D, P>. + /*! + \internal + \brief Forward iterator on the \p N-faces sites of an + mln::p_faces<N, D, P>. + */ template <unsigned N, unsigned D, typename P> class p_faces_fwd_piter_ : public internal::p_complex_piter_base_< topo::faces_fwd_iter_<N, D>, @@ -79,8 +83,11 @@ namespace mln | p_faces_bkd_piter_<N, D, P>. | `------------------------------*/ - /// \brief Backward iterator on the \p N-faces sites of an - /// mln::p_faces<N, D, P>. + /*! + \internal + \brief Backward iterator on the \p N-faces sites of an + mln::p_faces<N, D, P>. + */ template <unsigned N, unsigned D, typename P> class p_faces_bkd_piter_ /* FIXME: Rename internal::p_complex_piter_base_ to something else, diff --git a/milena/mln/core/site_set/box_piter.hh b/milena/mln/core/site_set/box_piter.hh index b031654..d3b548f 100644 --- a/milena/mln/core/site_set/box_piter.hh +++ b/milena/mln/core/site_set/box_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -38,12 +39,14 @@ namespace mln { - /// \brief A generic forward iterator on points of boxes. - /// - /// The parameter \c P is the type of points. - /// - /// \see mln::box - /// + /*! + \internal + \brief A generic forward iterator on points of boxes. + + The parameter \c P is the type of points. + + \see mln::box + */ template <typename P> class box_fwd_piter_ : public internal::site_set_iterator_base< box<P>, box_fwd_piter_<P> > @@ -84,12 +87,14 @@ namespace mln - /// A generic backward iterator on points of boxes. - /// - /// The parameter \c P is the type of points. - /// - /// \see mln::box - /// + /*! + \internal + \brief A generic backward iterator on points of boxes. + + The parameter \c P is the type of points. + + \see mln::box + */ template <typename P> class box_bkd_piter_ : public internal::site_set_iterator_base< box<P>, box_bkd_piter_<P> > diff --git a/milena/mln/core/site_set/complex_psite.hh b/milena/mln/core/site_set/complex_psite.hh index 9e150cc..c15c12d 100644 --- a/milena/mln/core/site_set/complex_psite.hh +++ b/milena/mln/core/site_set/complex_psite.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -227,7 +228,7 @@ namespace mln complex_psite<D, G>::complex_psite(const p_complex<D, G>& pc, unsigned n, unsigned face_id) : pc_(&pc), - face_(pc.cplx(), n, face_id) + face_(pc.cplx(), n, face_id) { if (is_valid()) update_(); diff --git a/milena/mln/core/site_set/p_array.hh b/milena/mln/core/site_set/p_array.hh index 0ca810e..08a041e 100644 --- a/milena/mln/core/site_set/p_array.hh +++ b/milena/mln/core/site_set/p_array.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -177,8 +177,10 @@ namespace mln - /// Psite class for indexed site sets such as p_array<P>. - /// + /*! + \internal + \brief Psite class for indexed site sets such as p_array<P>. + */ template <typename S> class p_indexed_psite : public internal::pseudo_site_base_< const mln_element(S)&, p_indexed_psite<S> > @@ -229,8 +231,10 @@ namespace mln - /// Forward iterator on sites of an indexed site set. - + /*! + \internal + \brief Forward iterator on sites of an indexed site set. + */ template <typename S> class p_indexed_fwd_piter : @@ -270,8 +274,10 @@ namespace mln - /// Backward iterator on sites of an indexed site set. - + /*! + \internal + \brief Backward iterator on sites of an indexed site set. + */ template <typename S> class p_indexed_bkd_piter : diff --git a/milena/mln/core/site_set/p_complex_piter.hh b/milena/mln/core/site_set/p_complex_piter.hh index 9fa2282..ac52cb7 100644 --- a/milena/mln/core/site_set/p_complex_piter.hh +++ b/milena/mln/core/site_set/p_complex_piter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -48,7 +48,10 @@ namespace mln | p_complex_fwd_piter_<D, G>. | `-----------------------------*/ - /// \brief Forward iterator on (all) the faces of an mln::p_complex<D, G>. + /*! + \internal + \brief Forward iterator on (all) the faces of an mln::p_complex<D, G>. + */ template <unsigned D, typename G> class p_complex_fwd_piter_ : public internal::p_complex_piter_base_< topo::face_fwd_iter<D>, @@ -75,7 +78,10 @@ namespace mln | p_complex_bkd_piter_<D, G>. | `-----------------------------*/ - /// \brief Backward iterator on (all) the faces of an mln::p_complex<D, G>. + /*! + \internal + \brief Backward iterator on (all) the faces of an mln::p_complex<D, G>. + */ template <unsigned D, typename G> class p_complex_bkd_piter_ : public internal::p_complex_piter_base_< topo::face_bkd_iter<D>, diff --git a/milena/mln/core/site_set/p_edges_psite.hh b/milena/mln/core/site_set/p_edges_psite.hh index c72e9bb..9b0a0fa 100644 --- a/milena/mln/core/site_set/p_edges_psite.hh +++ b/milena/mln/core/site_set/p_edges_psite.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -89,8 +90,10 @@ namespace mln namespace internal { - /// Subject_impl (Proxy) - + /*! + \internal + \brief Subject_impl (Proxy) + */ template <typename G, typename F, typename E> struct subject_impl< const p_edges_psite<G,F>&, E > : subject_impl< const graph_psite_base< p_edges<G,F>, diff --git a/milena/mln/core/site_set/p_graph_piter.hh b/milena/mln/core/site_set/p_graph_piter.hh index 12b7e0d..2a52048 100644 --- a/milena/mln/core/site_set/p_graph_piter.hh +++ b/milena/mln/core/site_set/p_graph_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -50,7 +51,10 @@ namespace mln | p_graph_piter<S,I>. | `------------------------*/ - /// Generic iterator on point sites of a mln::S. + /*! + \internal + \brief Generic iterator on point sites of a mln::S. + */ template <typename S, typename I> class p_graph_piter : public internal::site_set_iterator_base< S, @@ -112,7 +116,10 @@ namespace mln { /// \{ - /// subject_impl specialization (Proxy) + /*! + \internal + \brief subject_impl specialization (Proxy) + */ template <typename S, typename I, typename E> struct subject_impl< const p_graph_piter<S,I>&, E > { diff --git a/milena/mln/core/site_set/p_if_piter.hh b/milena/mln/core/site_set/p_if_piter.hh index 8bfa124..7820d40 100644 --- a/milena/mln/core/site_set/p_if_piter.hh +++ b/milena/mln/core/site_set/p_if_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -39,13 +40,15 @@ namespace mln { - /*! \brief Iterator on site sets conditionned by a function. - * - * Parameter \c S is a site set type; parameter F is a function - * from point to Boolean. - * - * \see mln::p_if - */ + /*! + \internal + \brief Iterator on site sets conditionned by a function. + + Parameter \c S is a site set type; parameter F is a function + from point to Boolean. + + \see mln::p_if + */ template <typename Pi, typename S, typename F> struct p_if_piter_ : public internal::piter_adaptor_< Pi, // Adaptee. @@ -112,7 +115,7 @@ namespace mln pi_.next(); while (pi_.is_valid() && ! s_->pred(pi_)); } - + template <typename Pi, typename S, typename F> inline void diff --git a/milena/mln/core/site_set/p_n_faces_piter.hh b/milena/mln/core/site_set/p_n_faces_piter.hh index 3282be8..0a1849f 100644 --- a/milena/mln/core/site_set/p_n_faces_piter.hh +++ b/milena/mln/core/site_set/p_n_faces_piter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -50,8 +50,11 @@ namespace mln | p_n_faces_fwd_piter<D, G>. | `----------------------------*/ - /// \brief Forward iterator on the n-faces sites of an - /// mln::p_complex<D, G>. + /*! + \internal + \brief Forward iterator on the n-faces sites of an + mln::p_complex<D, G>. + */ template <unsigned D, typename G> class p_n_faces_fwd_piter : public internal::p_complex_piter_base_< topo::n_face_fwd_iter<D>, @@ -86,8 +89,11 @@ namespace mln | p_n_faces_bkd_piter<D, G>. | `----------------------------*/ - /// \brief Backward iterator on the n-faces sites of an - /// mln::p_complex<D, G>. + /*! + \internal + \brief Backward iterator on the n-faces sites of an + mln::p_complex<D, G>. + */ template <unsigned D, typename G> class p_n_faces_bkd_piter /* FIXME: Rename internal::p_complex_piter_base_ to something else, @@ -145,7 +151,7 @@ namespace mln template <unsigned D, typename G> inline - unsigned + unsigned p_n_faces_fwd_piter<D, G>::n() const { return this->iter_.n(); @@ -158,7 +164,7 @@ namespace mln { this->iter_.set_n(n); } - + /*----------------------------. | p_n_faces_bkd_piter<D, G>. | @@ -182,7 +188,7 @@ namespace mln template <unsigned D, typename G> inline - unsigned + unsigned p_n_faces_bkd_piter<D, G>::n() const { return this->iter_.n(); diff --git a/milena/mln/core/site_set/p_run_piter.hh b/milena/mln/core/site_set/p_run_piter.hh index dd04610..1495723 100644 --- a/milena/mln/core/site_set/p_run_piter.hh +++ b/milena/mln/core/site_set/p_run_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -38,9 +39,10 @@ namespace mln { - /*! \brief Forward iterator on points of a p_run<P>. - * - */ + /*! + \internal + \brief Forward iterator on points of a p_run<P>. + */ template <typename P> class p_run_fwd_piter_ : @@ -76,9 +78,10 @@ namespace mln - /*! \brief Backward iterator on points of a p_run<P>. - * - */ + /*! + \internal + \brief Backward iterator on points of a p_run<P>. + */ template <typename P> class p_run_bkd_piter_ : diff --git a/milena/mln/core/site_set/p_transformed_piter.hh b/milena/mln/core/site_set/p_transformed_piter.hh index 25375fb..505c72d 100644 --- a/milena/mln/core/site_set/p_transformed_piter.hh +++ b/milena/mln/core/site_set/p_transformed_piter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -39,13 +40,15 @@ namespace mln { - /// Iterator on p_transformed<S,F>. - /// - /// Parameter \c S is a site set type; parameter F is a function - /// from point to Boolean. - /// - /// \see mln::p_transformed - // + /*! + \internal + \brief Iterator on p_transformed<S,F>. + + Parameter \c S is a site set type; parameter F is a function + from point to Boolean. + + \see mln::p_transformed + */ template <typename Pi, typename S, typename F> struct p_transformed_piter : public internal::site_set_iterator_base< p_transformed<S,F>, // Site_Set. @@ -59,16 +62,16 @@ namespace mln /// Test the iterator validity. bool is_valid_() const; - + /// Invalidate the iterator. void invalidate_(); - + /// Start an iteration. void start_(); - + /// Go to the next point. void next_(); - + /// Change the set site targeted by this iterator. void change_target(const p_transformed<S,F>& s); diff --git a/milena/mln/core/site_set/p_vertices_psite.hh b/milena/mln/core/site_set/p_vertices_psite.hh index 320796f..a8b2cb2 100644 --- a/milena/mln/core/site_set/p_vertices_psite.hh +++ b/milena/mln/core/site_set/p_vertices_psite.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -84,8 +84,10 @@ namespace mln namespace internal { - /// Subject_impl (Proxy) - + /*! + \internal + \brief Subject_impl (Proxy) + */ template <typename G, typename F, typename E> struct subject_impl< const p_vertices_psite<G,F>&, E > : subject_impl< const graph_psite_base< p_vertices<G,F>, diff --git a/milena/mln/fun/c.hh b/milena/mln/fun/c.hh index a09325c..32666d0 100644 --- a/milena/mln/fun/c.hh +++ b/milena/mln/fun/c.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,12 +42,18 @@ namespace mln { - /// Concept-like. + /*! + \internal + \brief Concept-like. + */ template <typename E> struct C_Function; - /// Category declaration for a unary C function. + /*! + \internal + \brief Category declaration for a unary C function. + */ template <typename R, typename A> struct category< R (*)(A) > { diff --git a/milena/mln/fun/internal/ch_function_value_impl.hh b/milena/mln/fun/internal/ch_function_value_impl.hh index 387cb17..185634a 100644 --- a/milena/mln/fun/internal/ch_function_value_impl.hh +++ b/milena/mln/fun/internal/ch_function_value_impl.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -39,7 +40,10 @@ namespace mln namespace internal { - /// Default implementation. + /*! + \internal + \brief Default implementation. + */ template <typename F, typename V> struct ch_function_value_impl { diff --git a/milena/mln/fun/v2v/ch_function_value.hh b/milena/mln/fun/v2v/ch_function_value.hh index 68fc9ee..8fc6f32 100644 --- a/milena/mln/fun/v2v/ch_function_value.hh +++ b/milena/mln/fun/v2v/ch_function_value.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -47,7 +48,7 @@ namespace mln namespace v2v { - /// Wrap a function v2v and convert its result to another type. + /// \brief Wrap a function v2v and convert its result to another type. template <typename F, typename V> class ch_function_value : public Function_v2v< ch_function_value<F,V> >, public internal::ch_function_value_impl<F, V> diff --git a/milena/mln/fun/x2x/composed.hh b/milena/mln/fun/x2x/composed.hh index a95dfeb..162e2fe 100644 --- a/milena/mln/fun/x2x/composed.hh +++ b/milena/mln/fun/x2x/composed.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -58,7 +58,10 @@ namespace mln struct helper_composed_; - /// Helper for describing a bijective composition. + /*! + \internal + \brief Helper for describing a bijective composition. + */ template <typename T2, typename T1, typename E> struct helper_composed_<T2,T1,E,true> : public fun::internal::x2x_linear_impl_<mln_result(T2), typename T2::data_t, E >, @@ -99,7 +102,10 @@ namespace mln T1 g_; }; - /// Helper for describing a non bijective composition. + /*! + \internal + \brief Helper for describing a non bijective composition. + */ template <typename T2, typename T1, typename E> struct helper_composed_<T2,T1,E,false> : public fun::internal::x2x_linear_impl_<mln_result(T2), typename T2::data_t, E >, diff --git a/milena/mln/geom/complex_geometry.hh b/milena/mln/geom/complex_geometry.hh index ef23c3e..fbad8c4 100644 --- a/milena/mln/geom/complex_geometry.hh +++ b/milena/mln/geom/complex_geometry.hh @@ -114,9 +114,12 @@ namespace mln namespace internal { - /// The data stored in a complex_geometry object. - /// - /// \tparam P The type of the location of a 0-face. + /*! + \internal + \brief The data stored in a complex_geometry object. + + \tparam P The type of the location of a 0-face. + */ template <typename P> struct complex_geometry_data { diff --git a/milena/mln/labeling/blobs.hh b/milena/mln/labeling/blobs.hh index ce06b7d..d41563f 100644 --- a/milena/mln/labeling/blobs.hh +++ b/milena/mln/labeling/blobs.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -74,8 +74,10 @@ namespace mln namespace internal { - /// Functor not computing anything. To be passed to the labeling - /// blobs canvas. + /*! + \brief Functor not computing anything. To be passed to the labeling + blobs canvas. + */ template <typename L> struct dummy_functor { diff --git a/milena/mln/labeling/blobs_and_compute.hh b/milena/mln/labeling/blobs_and_compute.hh index 744d411..d53f174 100644 --- a/milena/mln/labeling/blobs_and_compute.hh +++ b/milena/mln/labeling/blobs_and_compute.hh @@ -72,8 +72,11 @@ namespace mln namespace internal { - /// Functor not computing anything. To be passed to the labeling - /// blobs canvas. + /*! + \internal + \brief Functor not computing anything. + To be passed to the labeling blobs canvas. + */ template <typename L, typename A> struct compute_functor { diff --git a/milena/mln/metal/ands.hh b/milena/mln/metal/ands.hh index b2329a1..6a65436 100644 --- a/milena/mln/metal/ands.hh +++ b/milena/mln/metal/ands.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -38,8 +39,11 @@ namespace mln namespace metal { - - /// Ands type. + + /*! + \internal + \brief Ands type. + */ template < typename E1, typename E2, typename E3, diff --git a/milena/mln/metal/bexpr.hh b/milena/mln/metal/bexpr.hh index 0dc1821..1631151 100644 --- a/milena/mln/metal/bexpr.hh +++ b/milena/mln/metal/bexpr.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,26 +46,38 @@ namespace mln namespace metal { - - /// Negate type. + + /*! + \internal + \brief Negate type. + */ template <typename B> struct not_ : bool_<( ! B::value )> {}; - - /// And type. + + /*! + \internal + \brief And type. + */ template <typename L, typename R> struct and_ : bool_<( L::value && R::value )> {}; - - /// Or type. + + /*! + \internal + \brief Or type. + */ template <typename L, typename R> struct or_ : bool_<( L::value || R::value )> {}; - - /// Xor type. + + /*! + \internal + \brief Xor type. + */ template <typename L, typename R> struct xor_ : bool_<( L::value ^ R::value )> {}; diff --git a/milena/mln/metal/bool.hh b/milena/mln/metal/bool.hh index 3960b8d..4b6ff59 100644 --- a/milena/mln/metal/bool.hh +++ b/milena/mln/metal/bool.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -50,7 +51,10 @@ namespace mln template <bool b> struct bool_; - /// "true" type. + /*! + \internal + \brief "true" type. + */ template <> struct bool_< true > { @@ -64,7 +68,10 @@ namespace mln typedef bool_<true> true_; - /// "false" type. + /*! + \internal + \brief "false" type. + */ template <> struct bool_< false > { diff --git a/milena/mln/metal/converts_to.hh b/milena/mln/metal/converts_to.hh index 25be3e9..8d877ba 100644 --- a/milena/mln/metal/converts_to.hh +++ b/milena/mln/metal/converts_to.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -73,7 +74,10 @@ namespace mln - /// \brief "converts-to" check. + /*! + \internal + \brief "converts-to" check. + */ template <typename T, typename U> struct converts_to : bool_<( sizeof(internal::helper_converts_to_<T, U> ::selector(*internal::make_<mlc_const(T)>::ptr(), diff --git a/milena/mln/metal/equal.hh b/milena/mln/metal/equal.hh index 47b7c4f..170ed91 100644 --- a/milena/mln/metal/equal.hh +++ b/milena/mln/metal/equal.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -42,9 +43,11 @@ namespace mln namespace metal { - /// Definition of a static 'equal' test. - /// Check whether type T1 is exactly type T2. - // + /*! + \internal + \brief Definition of a static 'equal' test. + Check whether type T1 is exactly type T2. + */ template <typename T1, typename T2> struct equal : false_ {}; diff --git a/milena/mln/metal/goes_to.hh b/milena/mln/metal/goes_to.hh index f8757c9..79bbd15 100644 --- a/milena/mln/metal/goes_to.hh +++ b/milena/mln/metal/goes_to.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,14 +46,16 @@ namespace mln namespace metal { - /*! \brief "goes-to" check. - * - * FIXME: Doc! - */ + /*! + \internal + \brief "goes-to" check. + + FIXME: Doc! + */ template <typename T, typename U> struct goes_to : or_< mlc_converts_to(T,U), mlc_is(T,U) >::eval {}; - + } // end of namespace mln::metal diff --git a/milena/mln/metal/if.hh b/milena/mln/metal/if.hh index ab5a64f..5adb0e7 100644 --- a/milena/mln/metal/if.hh +++ b/milena/mln/metal/if.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -64,10 +65,12 @@ namespace mln } // end of namespace mln::metal::internal - /*! \brief "if-then-else" expression. - * - * FIXME: Doc! - */ + /*! + \internal + \brief "if-then-else" expression. + + FIXME: Doc! + */ template <typename Cond, typename Then, typename Else> struct if_ : internal::helper_if_< Cond::value, Then, Else > { diff --git a/milena/mln/metal/int.hh b/milena/mln/metal/int.hh index a216db9..d52291c 100644 --- a/milena/mln/metal/int.hh +++ b/milena/mln/metal/int.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,7 +42,10 @@ namespace mln namespace metal { - /// "int" type. + /*! + \internal + \brief "int" type. + */ template <int i> struct int_ { diff --git a/milena/mln/metal/is.hh b/milena/mln/metal/is.hh index 10db237..f4f2c10 100644 --- a/milena/mln/metal/is.hh +++ b/milena/mln/metal/is.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -57,9 +58,11 @@ namespace mln - /// \brief "is" check. - /// Check whether T inherits from U. - // + /*! + \internal + \brief "is" check. + Check whether T inherits from U. + */ template <typename T, typename U> struct is : bool_<( sizeof(internal::helper_is_<T, U>::selector(internal::make_<T>::ptr())) == diff --git a/milena/mln/metal/is_a.hh b/milena/mln/metal/is_a.hh index 2244c33..7a0c803 100644 --- a/milena/mln/metal/is_a.hh +++ b/milena/mln/metal/is_a.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -33,14 +34,16 @@ # include <mln/metal/bool.hh> -/// \brief Expand to a "metalic" boolean expression stating whether \a -/// T is a subclass of \a M or not. -/// -/// In the current implementation, \a M must be template class with -/// exactly one, non template parameter. -/// -/// This macro is the recommended user interface of the "is_a" -/// facility. +/*! + \brief Expand to a "metalic" boolean expression stating whether \a + T is a subclass of \a M or not. + + In the current implementation, \a M must be template class with + exactly one, non template parameter. + + This macro is the recommended user interface of the "is_a" + facility. +*/ # define mlc_is_a(T, M) mln::metal::is_a<T, M> @@ -87,28 +90,30 @@ namespace mln - /// \brief "is_a" check. - /// - /// Check whether T inherits from _CONCEPT_ M. - // + /*! + \internal + \brief "is_a" check. + + Check whether T inherits from _CONCEPT_ M. + */ template <typename T, template <class> class M> struct is_a : bool_<( sizeof( internal::helper_is_a_< T, M >::selector(internal::make_< T >::ptr()) ) == sizeof( internal::yes_ ) )> {}; - + template <typename T, template <class> class M> struct is_a< const T, M > : is_a< T, M >::eval {}; - + template <typename T, template <class> class M> struct is_a< T&, M > : is_a< T, M >::eval {}; - + template <typename T, template <class> class M> struct is_a< const T&, M > : is_a< T, M >::eval {}; - + } // end of namespace mln::metal diff --git a/milena/mln/metal/is_not.hh b/milena/mln/metal/is_not.hh index 2857934..c00d009 100644 --- a/milena/mln/metal/is_not.hh +++ b/milena/mln/metal/is_not.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -44,10 +45,12 @@ namespace mln namespace metal { - /*! \brief "is_not" check. - * - * FIXME: Doc! - */ + /*! + \internal + \brief "is_not" check. + + FIXME: Doc! + */ template <typename T, typename U> struct is_not : not_< is<T, U> >::eval { diff --git a/milena/mln/metal/is_not_a.hh b/milena/mln/metal/is_not_a.hh index 1519590..15cbac6 100644 --- a/milena/mln/metal/is_not_a.hh +++ b/milena/mln/metal/is_not_a.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +44,10 @@ namespace mln namespace metal { - /// "is_not_a" static Boolean expression. + /*! + \internal + \brief "is_not_a" static Boolean expression. + */ template <typename T, template <class> class M> struct is_not_a : not_< is_a<T, M> >::eval { diff --git a/milena/mln/pw/image.hh b/milena/mln/pw/image.hh index f88a811..ccf5b9e 100644 --- a/milena/mln/pw/image.hh +++ b/milena/mln/pw/image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -59,7 +60,10 @@ namespace mln namespace internal { - /// Data structure for mln::pw::internal::image + /*! + \internal + \brief Data structure for mln::pw::internal::image + */ template <typename F, typename S> struct data< mln::pw::image<F,S> > { diff --git a/milena/mln/pw/internal/image_base.hh b/milena/mln/pw/internal/image_base.hh index 537f2eb..87693dc 100644 --- a/milena/mln/pw/internal/image_base.hh +++ b/milena/mln/pw/internal/image_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009, 2010 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2010, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -107,9 +108,13 @@ namespace mln namespace internal { - /// A base class for point-wise images. - /// Parameter \p F is the image value type. - /// Parameter \p S is the image site set type. + /*! + \internal + \brief A base class for point-wise images. + + Parameter \p F is the image value type. + Parameter \p S is the image site set type. + */ template <typename F, typename S, typename E> class image_base : public mln::internal::image_primary<mln_result(F), S, E > 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 034f139..5b04e19 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 @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -56,11 +57,12 @@ 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>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! \internal + \brief Forward iterator on all the n-faces sharing an adjacent + (n+1)-face with a (reference) n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_higher_dim_connected_n_face_fwd_iter : public internal::forward_complex_relative_iterator_base< topo::face<D>, @@ -95,11 +97,13 @@ namespace mln | 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>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Backward iterator on all the n-faces sharing an adjacent + (n+1)-face with a (reference) n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_higher_dim_connected_n_face_bkd_iter : public internal::backward_complex_relative_iterator_base< topo::face<D>, diff --git a/milena/mln/topo/adj_higher_face_iter.hh b/milena/mln/topo/adj_higher_face_iter.hh index 2b4ef65..797c5d1 100644 --- a/milena/mln/topo/adj_higher_face_iter.hh +++ b/milena/mln/topo/adj_higher_face_iter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -63,11 +63,13 @@ namespace mln | topo::adj_higher_face_fwd_iter<D>. | `------------------------------------*/ - /// \brief Forward iterator on all the adjacent (n+1)-faces of the - /// n-face of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Forward iterator on all the adjacent (n+1)-faces of the + n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_higher_face_fwd_iter : public internal::forward_complex_relative_iterator_base< topo::face<D>, @@ -97,11 +99,13 @@ namespace mln | topo::adj_higher_face_bkd_iter<D>. | `------------------------------------*/ - /// \brief Backward iterator on all the adjacent (n+1)-faces of - /// the n-face of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Backward iterator on all the adjacent (n+1)-faces of + the n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_higher_face_bkd_iter : public internal::backward_complex_relative_iterator_base< topo::face<D>, 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 d493ea9..24f2800 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 @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -56,11 +57,13 @@ namespace mln | topo::adj_lower_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>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Forward iterator on all the n-faces sharing an adjacent + (n-1)-face with a (reference) n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_lower_dim_connected_n_face_fwd_iter : public internal::forward_complex_relative_iterator_base< topo::face<D>, @@ -95,11 +98,13 @@ namespace mln | topo::adj_lower_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>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Backward iterator on all the n-faces sharing an adjacent + (n-1)-face with a (reference) n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_lower_dim_connected_n_face_bkd_iter : public internal::backward_complex_relative_iterator_base< topo::face<D>, diff --git a/milena/mln/topo/adj_lower_face_iter.hh b/milena/mln/topo/adj_lower_face_iter.hh index a903460..5a6b7f0 100644 --- a/milena/mln/topo/adj_lower_face_iter.hh +++ b/milena/mln/topo/adj_lower_face_iter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -64,11 +64,13 @@ namespace mln | topo::adj_lower_face_fwd_iter<D>. | `-----------------------------------*/ - /// \brief Forward iterator on all the adjacent (n-1)-faces of the - /// n-face of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Forward iterator on all the adjacent (n-1)-faces of the + n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_lower_face_fwd_iter : public internal::forward_complex_relative_iterator_base< topo::face<D>, @@ -99,11 +101,13 @@ namespace mln | topo::adj_lower_face_bkd_iter<D>. | `-----------------------------------*/ - /// \brief Backward iterator on all the adjacent (n-1)-faces of - /// the n-face of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Backward iterator on all the adjacent (n-1)-faces of + the n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_lower_face_bkd_iter : public internal::backward_complex_relative_iterator_base< topo::face<D>, diff --git a/milena/mln/topo/adj_lower_higher_face_iter.hh b/milena/mln/topo/adj_lower_higher_face_iter.hh index 2ed4abd..4788ed7 100644 --- a/milena/mln/topo/adj_lower_higher_face_iter.hh +++ b/milena/mln/topo/adj_lower_higher_face_iter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -63,10 +64,13 @@ namespace mln | topo::adj_lower_higher_face_fwd_iter<D>. | `------------------------------------------*/ - /// Forward iterator on all the adjacent (n-1)-faces and - /// (n+1)-faces of the n-face of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. + /*! + \internal + \brief Forward iterator on all the adjacent (n-1)-faces and + (n+1)-faces of the n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_lower_higher_face_fwd_iter : public internal::complex_relative_iterator_sequence<adj_lower_face_fwd_iter<D>, @@ -94,10 +98,13 @@ namespace mln | topo::adj_lower_higher_face_bkd_iter<D>. | `------------------------------------------*/ - /// Forward iterator on all the adjacent (n-1)-faces and - /// (n+1)-faces of the n-face of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. + /*! + \internal + \brief Forward iterator on all the adjacent (n-1)-faces and + (n+1)-faces of the n-face of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class adj_lower_higher_face_bkd_iter : public internal::complex_relative_iterator_sequence<adj_higher_face_bkd_iter<D>, diff --git a/milena/mln/topo/adj_m_face_iter.hh b/milena/mln/topo/adj_m_face_iter.hh index 1b070a9..abe4514 100644 --- a/milena/mln/topo/adj_m_face_iter.hh +++ b/milena/mln/topo/adj_m_face_iter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -57,15 +58,18 @@ namespace mln | topo::adj_m_face_fwd_iter<D>. | `-------------------------------*/ - /** Forward iterator on all the m-faces transitively - adjacent to a (reference) n-face in a complex. + /*! + \internal + \brief Forward iterator on all the m-faces transitively + adjacent to a (reference) n-face in a complex. - \tparam D The dimension of the complex this iterator belongs to. + \tparam D The dimension of the complex this iterator belongs to. - The dimension parameter (\a m_) must be lower or equal to D. + The dimension parameter (\a m_) must be lower or equal to D. - If \a m_ is equal to the dimension of the reference face, then - the iterated set is empty. */ + If \a m_ is equal to the dimension of the reference face, then + the iterated set is empty. + */ template <unsigned D> class adj_m_face_fwd_iter : public internal::forward_complex_relative_iterator_base< topo::face<D>, @@ -105,15 +109,18 @@ namespace mln | topo::adj_m_face_bkd_iter<D>. | `-------------------------------*/ - /** Backward iterator on all the m-faces transitively - adjacent to a (reference) n-face in a complex. + /*! + \internal + \brief Backward iterator on all the m-faces transitively + adjacent to a (reference) n-face in a complex. - \tparam D The dimension of the complex this iterator belongs to. + \tparam D The dimension of the complex this iterator belongs to. - The dimension parameter (\a m_) must be lower or equal to D. + The dimension parameter (\a m_) must be lower or equal to D. - If \a m_ is equal to the dimension of the reference face, then - the iterated set is empty. */ + If \a m_ is equal to the dimension of the reference face, then + the iterated set is empty. + */ template <unsigned D> class adj_m_face_bkd_iter : public internal::backward_complex_relative_iterator_base< topo::face<D>, diff --git a/milena/mln/topo/attic/faces_iter.hh b/milena/mln/topo/attic/faces_iter.hh index eca6f40..b97397e 100644 --- a/milena/mln/topo/attic/faces_iter.hh +++ b/milena/mln/topo/attic/faces_iter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,10 +44,13 @@ namespace mln | topo::faces_fwd_iter_<N, D>. | `------------------------------*/ - /// \brief Forward iterator on all the faces of a mln::complex<D>. - /// - /// \tparam N The dimension of the face associated to this iterator. - /// \tparam D The dimension of the complex this iterator belongs to. + /*! + \internal + \brief Forward iterator on all the faces of a mln::complex<D>. + + \tparam N The dimension of the face associated to this iterator. + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned N, unsigned D> class faces_fwd_iter_ : public internal::complex_set_iterator_base< n_face<N, D>, @@ -90,10 +94,13 @@ namespace mln | topo::faces_bkd_iter_<N, D>. | `------------------------------*/ - /// \brief Backward iterator on all the faces of a mln::complex<D>. - /// - /// \tparam N The dimension of the face associated to this iterator. - /// \tparam D The dimension of the complex this iterator belongs to. + /*! + \internal + \brief Backward iterator on all the faces of a mln::complex<D>. + + \tparam N The dimension of the face associated to this iterator. + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned N, unsigned D> class faces_bkd_iter_ : public internal::complex_set_iterator_base< n_face<N, D>, diff --git a/milena/mln/topo/center_only_iter.hh b/milena/mln/topo/center_only_iter.hh index 5e695ce..a5b08b3 100644 --- a/milena/mln/topo/center_only_iter.hh +++ b/milena/mln/topo/center_only_iter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -52,24 +52,27 @@ namespace mln | topo::center_only_iter<D>. | `----------------------------*/ - /** \brief Iterator on all the adjacent (n-1)-faces of the n-face - of an mln::complex<D>. - - \tparam D The dimension of the complex this iterator belongs to. - - mln::topo::center_only_iter inherits from - mln::topo::internal::forward_complex_relative_iterator_base, - but it could inherit from - mln::topo::internal::backward_complex_relative_iterator_base - as well, since it always contains a single element, the - center/reference face (and the traversal order is - meaningless). - - This iterator is essentially used to implement other iterators. - \see mln::topo::centered_iter_adapter - \see mln::complex_lower_window - \see mln::complex_higher_window - \see mln::complex_lower_higher_window */ + /*! + \internal + \brief Iterator on all the adjacent (n-1)-faces of the n-face + of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + + mln::topo::center_only_iter inherits from + mln::topo::internal::forward_complex_relative_iterator_base, + but it could inherit from + mln::topo::internal::backward_complex_relative_iterator_base + as well, since it always contains a single element, the + center/reference face (and the traversal order is + meaningless). + + This iterator is essentially used to implement other iterators. + \see mln::topo::centered_iter_adapter + \see mln::complex_lower_window + \see mln::complex_higher_window + \see mln::complex_lower_higher_window + */ template <unsigned D> class center_only_iter : public internal::forward_complex_relative_iterator_base< topo::face<D>, diff --git a/milena/mln/topo/centered_iter_adapter.hh b/milena/mln/topo/centered_iter_adapter.hh index 4a6e0cc..bc19dc5 100644 --- a/milena/mln/topo/centered_iter_adapter.hh +++ b/milena/mln/topo/centered_iter_adapter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -48,11 +49,14 @@ namespace mln // FIXME: We should deduce D from I. - /// \brief Backward complex relative iterator adapters adding the - /// central (reference) point to the set of iterated faces. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - /// \tparam I The adapated complex relative iterator. + /*! + \internal + \brief Backward complex relative iterator adapters adding the + central (reference) point to the set of iterated faces. + + \tparam D The dimension of the complex this iterator belongs to. + \tparam I The adapated complex relative iterator. + */ template <unsigned D, typename I> class centered_fwd_iter_adapter : public internal::complex_relative_iterator_sequence< center_only_iter<D>, @@ -82,11 +86,14 @@ namespace mln // FIXME: We should deduce D from I. - /// \brief Forward complex relative iterator adapters adding the - /// central (reference) point to the set of iterated faces. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - /// \tparam I The adapated complex relative iterator. + /*! + \internal + \brief Forward complex relative iterator adapters adding the + central (reference) point to the set of iterated faces. + + \tparam D The dimension of the complex this iterator belongs to. + \tparam I The adapated complex relative iterator. + */ template <unsigned D, typename I> class centered_bkd_iter_adapter : public internal::complex_relative_iterator_sequence< I, diff --git a/milena/mln/topo/complex.hh b/milena/mln/topo/complex.hh index 9a3d4bb..ab24b9f 100644 --- a/milena/mln/topo/complex.hh +++ b/milena/mln/topo/complex.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -81,8 +81,9 @@ namespace mln | Complex. | `----------*/ - /// \brief General complex of dimension \p D. - // + /*! + \brief General complex of dimension \p D. + */ template <unsigned D> class complex { @@ -240,12 +241,12 @@ namespace mln ,-----------> higher_dim_faces_set_mixin<0, D> | - faces_set_mixin<0, D> + faces_set_mixin<0, D> ^ | | ,-----------> higher_dim_faces_set_mixin<1, D> | | ,---------> lower_dim_faces_set_mixin<1, D> - | | | + | | | faces_set_mixin<1, D> ^ | @@ -257,13 +258,13 @@ namespace mln | | ,-----------> higher_dim_faces_set_mixin<D - 1, D> | | ,---------> lower_dim_faces_set_mixin<D - 1, D> - | | | + | | | faces_set_mixin<D - 1, D> ^ - | + | | ,---------> lower_dim_faces_set_mixin<D, D> - | | - faces_set_mixin<D, D> + | | + faces_set_mixin<D, D> ^ | | @@ -303,13 +304,16 @@ namespace mln // mln::topo::internal::faces_set_mixin. // // -------------------------------------- // - /// Recursive mixins of set of faces. + /// \internal \brief Recursive mixins of set of faces. /// \{ template <unsigned N, unsigned D> struct faces_set_mixin; - /// Faces of intermediate dimension (greater than 0, lower than \p D). + /*! + \internal + \brief Faces of intermediate dimension (greater than 0, lower than \p D). + */ template <unsigned N, unsigned D> struct faces_set_mixin : public faces_set_mixin<N - 1, D>, public lower_dim_faces_set_mixin<N, D>, @@ -340,7 +344,10 @@ namespace mln /// \} }; - /// Faces of highest dimension (\p D). + /*! + \internal + \brief Faces of highest dimension (\p D). + */ template <unsigned D> struct faces_set_mixin<D, D> : public faces_set_mixin<D - 1, D>, public lower_dim_faces_set_mixin<D, D> @@ -368,7 +375,10 @@ namespace mln /// \} }; - /// Faces of lowest dimension (0). + /*! + \internal + \brief Faces of lowest dimension (0). + */ template <unsigned D> struct faces_set_mixin<0u, D> : public higher_dim_faces_set_mixin<0u, D> { @@ -395,7 +405,10 @@ namespace mln /// \} }; - /// Faces of a 0-complex. + /*! + \internal + \brief Faces of a 0-complex. + */ template <> struct faces_set_mixin<0u, 0u> { @@ -428,7 +441,10 @@ namespace mln // class to be defined after the specializations of // 'faces_set_mixin'. - /// Complex data. + /*! + \internal + \brief Complex data. + */ template <unsigned D> struct complex_data : public faces_set_mixin<D, D> { @@ -441,7 +457,7 @@ namespace mln // mln::topo::internal::higher_dim_faces_set_mixin. // // ------------------------------------------------- // - /// Mixins of mixin mln::faces_set_mixin. + /// \internal \brief Mixins of mixin mln::faces_set_mixin. /// \{ template <unsigned N, unsigned D> struct lower_dim_faces_set_mixin @@ -538,14 +554,17 @@ namespace mln namespace internal { - /// A binary meta-functor defined by: - /// - /// \code - /// add_size : x, c -> x + c.size() - /// \endcode - /// - /// \see mln::complex<D>::nfaces_of_static_dim<N> (static version). - /// \see mln::complex<D>::fold_left_. + /*! + \internal + \brief A binary meta-functor defined by: + + \code + add_size : x, c -> x + c.size() + \endcode + + \see mln::complex<D>::nfaces_of_static_dim<N> (static version). + \see mln::complex<D>::fold_left_. + */ struct add_size { template <typename T, typename Container> @@ -555,14 +574,17 @@ namespace mln } }; - /// An unary meta-functor defined by: - /// - /// \code - /// add_size : c -> c.size() - /// \endcode - /// - /// \see mln::complex<D>::nfaces_of_dim (dynamic version). - /// \see mln::complex<D>::apply_if_dim_matches_. + /*! + \internal + \brief An unary meta-functor defined by: + + \code + add_size : c -> c.size() + \endcode + + \see mln::complex<D>::nfaces_of_dim (dynamic version). + \see mln::complex<D>::apply_if_dim_matches_. + */ struct get_size { typedef std::size_t result_type; @@ -719,7 +741,7 @@ namespace mln template <unsigned D> inline - const void* + const void* complex<D>::addr() const { return data_.ptr_; diff --git a/milena/mln/topo/face_data.hh b/milena/mln/topo/face_data.hh index 1622e51..118598a 100644 --- a/milena/mln/topo/face_data.hh +++ b/milena/mln/topo/face_data.hh @@ -105,7 +105,10 @@ namespace mln namespace internal { - /// Factored implementation of faces. + /*! + \internal + \brief Factored implementation of faces. + */ /// \{ template <unsigned N, unsigned D> class lower_dim_faces_data_mixin diff --git a/milena/mln/topo/face_iter.hh b/milena/mln/topo/face_iter.hh index 6e91a08..772ec77 100644 --- a/milena/mln/topo/face_iter.hh +++ b/milena/mln/topo/face_iter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -61,11 +61,13 @@ namespace mln | topo::face_fwd_iter<D>. | `-------------------------*/ - /// \brief Forward iterator on all the faces of an - /// mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Forward iterator on all the faces of an + mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class face_fwd_iter : public internal::complex_set_iterator_base< topo::face<D>, face_fwd_iter<D> > @@ -105,10 +107,12 @@ namespace mln | topo::face_bkd_iter<D>. | `-------------------------*/ - /// \brief Backward iterator on all the faces of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Backward iterator on all the faces of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class face_bkd_iter : public internal::complex_set_iterator_base< topo::face<D>, face_bkd_iter<D> > diff --git a/milena/mln/topo/internal/complex_iterator_base.hh b/milena/mln/topo/internal/complex_iterator_base.hh index bc8f26e..5c0d212 100644 --- a/milena/mln/topo/internal/complex_iterator_base.hh +++ b/milena/mln/topo/internal/complex_iterator_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -70,10 +71,13 @@ namespace mln namespace internal { - /// Factoring class for iterators on mln::complex. - /// - /// \tparam F The type of the face handle. - /// \tparam E The type exact type of the iterator. + /*! + \internal + \brief Factoring class for iterators on mln::complex. + + \tparam F The type of the face handle. + \tparam E The type exact type of the iterator. + */ template <typename F, typename E> class complex_iterator_base : public Iterator<E> { diff --git a/milena/mln/topo/internal/complex_relative_iterator_base.hh b/milena/mln/topo/internal/complex_relative_iterator_base.hh index 03f9cda..4fd03bf 100644 --- a/milena/mln/topo/internal/complex_relative_iterator_base.hh +++ b/milena/mln/topo/internal/complex_relative_iterator_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -32,7 +32,7 @@ iterators on mln::complex. The hierarchy of classes in this file is as follows - + \verbatim complex_relative_iterator_base<C, F, E> @@ -76,11 +76,14 @@ namespace mln | topo::internal::complex_relative_iterator_base<C, F, E>. | `----------------------------------------------------------*/ - /// Factoring class for relative iterators on mln::complex. - /// - /// \tparam C The type of the center face handle. - /// \tparam F The type of the face handle. - /// \tparam E The type exact type of the iterator. + /*! + \internal + \brief Factoring class for relative iterators on mln::complex. + + \tparam C The type of the center face handle. + \tparam F The type of the face handle. + \tparam E The type exact type of the iterator. + */ template <typename C, typename F, typename E> class complex_relative_iterator_base : public complex_iterator_base<F, E> @@ -128,12 +131,15 @@ namespace mln | topo::internal::forward_complex_relative_iterator_base<C, F, E>. | `------------------------------------------------------------------*/ - /// Factoring class for forward relative iterators on - /// mln::complex. - /// - /// \tparam C The type of the center face handle. - /// \tparam F The type of the face handle. - /// \tparam E The type exact type of the iterator. + /*! + \internal + \brief Factoring class for forward relative iterators on + mln::complex. + + \tparam C The type of the center face handle. + \tparam F The type of the face handle. + \tparam E The type exact type of the iterator. + */ template <typename C, typename F, typename E> class forward_complex_relative_iterator_base : public complex_relative_iterator_base<C, F, E> @@ -179,12 +185,15 @@ namespace mln | topo::internal::backward_complex_relative_iterator_base<C, F, E>. | `-------------------------------------------------------------------*/ - /// Factoring class for backward relative iterators on - /// mln::complex. - /// - /// \tparam C The type of the center face handle. - /// \tparam F The type of the face handle. - /// \tparam E The type exact type of the iterator. + /*! + \internal + \brief Factoring class for backward relative iterators on + mln::complex. + + \tparam C The type of the center face handle. + \tparam F The type of the face handle. + \tparam E The type exact type of the iterator. + */ template <typename C, typename F, typename E> class backward_complex_relative_iterator_base : public complex_relative_iterator_base<C, F, E> diff --git a/milena/mln/topo/internal/complex_relative_iterator_sequence.hh b/milena/mln/topo/internal/complex_relative_iterator_sequence.hh index fda267c..ed6b216 100644 --- a/milena/mln/topo/internal/complex_relative_iterator_sequence.hh +++ b/milena/mln/topo/internal/complex_relative_iterator_sequence.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -56,15 +57,18 @@ namespace mln }; - /// A meta relative iterator on the faces of a complex - /// using two complex relative iterators sequentially. - /// - /// The first relative iterator is used, and when it becomes - /// invalid, the second one is used. - /// - /// \tparam I1 The type of the first relative iterator. - /// \tparam I2 The type of the second relative iterator. - /// \tparam E The type exact type of the iterator. + /*! + \internal + \brief A meta relative iterator on the faces of a complex + using two complex relative iterators sequentially. + + The first relative iterator is used, and when it becomes + invalid, the second one is used. + + \tparam I1 The type of the first relative iterator. + \tparam I2 The type of the second relative iterator. + \tparam E The type exact type of the iterator. + */ template <typename I1, typename I2, typename E> class complex_relative_iterator_sequence : public Iterator<E> { diff --git a/milena/mln/topo/internal/complex_set_iterator_base.hh b/milena/mln/topo/internal/complex_set_iterator_base.hh index f428566..2cd9276 100644 --- a/milena/mln/topo/internal/complex_set_iterator_base.hh +++ b/milena/mln/topo/internal/complex_set_iterator_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -49,10 +49,13 @@ namespace mln class complex_iterator_base; - /// Factoring class for (set) iterators on mln::complex. - /// - /// \tparam F The type of the face handle. - /// \tparam E The type exact type of the iterator. + /*! + \internal + \brief Factoring class for (set) iterators on mln::complex. + + \tparam F The type of the face handle. + \tparam E The type exact type of the iterator. + */ template <typename F, typename E> class complex_set_iterator_base : public complex_iterator_base<F, E> { diff --git a/milena/mln/topo/n_face_iter.hh b/milena/mln/topo/n_face_iter.hh index 9dfc670..17090aa 100644 --- a/milena/mln/topo/n_face_iter.hh +++ b/milena/mln/topo/n_face_iter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -64,11 +64,13 @@ namespace mln | topo::n_face_fwd_iter<D>. | `---------------------------*/ - /// \brief Forward iterator on all the faces of an - /// mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Forward iterator on all the faces of an + mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class n_face_fwd_iter : public internal::complex_set_iterator_base< topo::face<D>, @@ -121,9 +123,12 @@ namespace mln | topo::n_face_bkd_iter<D>. | `---------------------------*/ - /// Backward iterator on all the faces of an mln::complex<D>. - /// - /// \tparam D The dimension of the complex this iterator belongs to. + /*! + \internal + \brief Backward iterator on all the faces of an mln::complex<D>. + + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned D> class n_face_bkd_iter : public internal::complex_set_iterator_base< topo::face<D>, diff --git a/milena/mln/topo/static_n_face_iter.hh b/milena/mln/topo/static_n_face_iter.hh index 21a7639..ebd22e3 100644 --- a/milena/mln/topo/static_n_face_iter.hh +++ b/milena/mln/topo/static_n_face_iter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,12 +46,14 @@ namespace mln | topo::static_n_face_fwd_iter<N, D>. | `-------------------------------------*/ - /// \brief Forward iterator on all the \p N-faces of a - /// mln::complex<D>. - /// - /// \tparam N The dimension of the face associated to this iterator. - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Forward iterator on all the \p N-faces of a + mln::complex<D>. + + \tparam N The dimension of the face associated to this iterator. + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned N, unsigned D> class static_n_face_fwd_iter : public internal::complex_set_iterator_base< topo::face<D>, @@ -91,12 +94,14 @@ namespace mln | topo::static_n_face_bkd_iter<N, D>. | `-------------------------------------*/ - /// \brief Backward iterator on all the \p N-faces of a - /// mln::complex<D>. - /// - /// \tparam N The dimension of the face associated to this iterator. - /// \tparam D The dimension of the complex this iterator belongs to. - // + /*! + \internal + \brief Backward iterator on all the \p N-faces of a + mln::complex<D>. + + \tparam N The dimension of the face associated to this iterator. + \tparam D The dimension of the complex this iterator belongs to. + */ template <unsigned N, unsigned D> class static_n_face_bkd_iter : public internal::complex_set_iterator_base< topo::face<D>, diff --git a/milena/mln/trait/ch_function_value.hh b/milena/mln/trait/ch_function_value.hh index 2c01e79..9a41ea9 100644 --- a/milena/mln/trait/ch_function_value.hh +++ b/milena/mln/trait/ch_function_value.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -52,7 +53,7 @@ namespace mln namespace impl { - /// Default. + // Default. template <typename F, typename VF, typename V> struct ch_function_value { diff --git a/milena/mln/trait/image/props.hh b/milena/mln/trait/image/props.hh index 2726814..2c90970 100644 --- a/milena/mln/trait/image/props.hh +++ b/milena/mln/trait/image/props.hh @@ -760,7 +760,10 @@ namespace mln // FIXME: To be moved elsewhere? - /// Compute the image::space trait from a point type. + /*! + \internal + \brief Compute the image::space trait from a point type. + */ /// \{ // Fwd decl. (used by trait::image::space_from_point). @@ -783,7 +786,10 @@ namespace mln namespace image { - /// Function mapping a point type to the corresponding space trait. + /*! + \internal + \brief Function mapping a point type to the corresponding space trait. + */ /// \{ template <typename P> struct space_from_point diff --git a/milena/mln/trait/images.hh b/milena/mln/trait/images.hh index 2ae9299..7541c07 100644 --- a/milena/mln/trait/images.hh +++ b/milena/mln/trait/images.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // diff --git a/milena/mln/trait/neighborhood.hh b/milena/mln/trait/neighborhood.hh index c63cd6f..623202a 100644 --- a/milena/mln/trait/neighborhood.hh +++ b/milena/mln/trait/neighborhood.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -59,27 +60,42 @@ namespace mln // FIXME: Might be moved to another file, as it's the case for // images and values. - /// Traits related to neighborhoods. + /*! + \internal + \brief Traits related to neighborhoods. + */ namespace neighborhood { - /// Kind of neighborhood. + /*! + \internal + \brief Kind of neighborhood. + */ struct kind { - /// The base class of the hierarchy of neighborhood traits. + /*! + \internal + \brief The base class of the hierarchy of neighborhood traits. + */ struct any { std::string name() const { return "kind::any"; } }; - /// A generic neighborhood, with no particular feature. + /*! + \internal + \brief A generic neighborhood, with no particular feature. + */ struct generic : any { std::string name() const { return "kind::generic"; } }; - /// A neighborhood on a regular grid, i.e. - /// holding/convertible to a window. + /*! + \internal + \brief A neighborhood on a regular grid, i.e. + holding/convertible to a window. + */ struct regular : any { std::string name() const { return "kind::regular"; } diff --git a/milena/mln/trait/promote.hh b/milena/mln/trait/promote.hh index 681ebde..3b5c5aa 100644 --- a/milena/mln/trait/promote.hh +++ b/milena/mln/trait/promote.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2006, 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2006, 2007, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -52,7 +53,10 @@ namespace mln namespace trait { - /// Declaration of the "promote" trait. + /*! + \internal + \brief Declaration of the "promote" trait. + */ template <typename T, typename U> struct promote : public solve_binary<promote, T, U> { @@ -60,10 +64,11 @@ namespace mln /*! - * \brief Default case when one type is involved twice: the - * promotion type is the same as the input type (so actually there - * is no promotion). - */ + \internal + \brief Default case when one type is involved twice: the + promotion type is the same as the input type (so actually there + is no promotion). + */ template <typename T> struct set_binary_< promote, Object, T, Object, T > { diff --git a/milena/mln/trait/site_set/props.hh b/milena/mln/trait/site_set/props.hh index 9d1fd31..859f3dd 100644 --- a/milena/mln/trait/site_set/props.hh +++ b/milena/mln/trait/site_set/props.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -38,41 +39,46 @@ # include <mln/trait/undef.hh> - -// Properties of site sets. -// ======================== - -// nsites: /any/ -// | -// + -- unknown -// | -// + -- known - -// bbox: /any/ -// | -// + -- unknown -// | -// + -- /known/ -// | -// + -- lazy -// | -// + -- straight - -// contents: /any/ -// | -// + -- fixed -// | -// + -- /dynamic/ -// | -// + -- growing -// | -// + -- free - -// arity: /any/ -// | -// + -- unique -// | -// + -- multiple +/*! + \verbatim + + Properties of site sets. + ======================== + + nsites: /any/ + | + + -- unknown + | + + -- known + + bbox: /any/ + | + + -- unknown + | + + -- /known/ + | + + -- lazy + | + + -- straight + + contents: /any/ + | + + -- fixed + | + + -- /dynamic/ + | + + -- growing + | + + -- free + + arity: /any/ + | + + -- unique + | + + -- multiple + + \endverbatim +*/ namespace mln @@ -85,59 +91,95 @@ namespace mln { - /// Site set property about the 'nsites' method presence. + /*! + \internal + \brief Site set property about the 'nsites' method presence. + */ struct nsites { - /// Base class for the site set 'nsites' property. + /*! + \internal + \brief Base class for the site set 'nsites' property. + */ struct any { protected: any() {} }; - /// Property that states that the number of sites cannot be - /// retrieved from a site set in O(1) complexity so the site - /// set does not feature the 'nsites' methods. + /*! + \internal + \brief Property that states that the number of sites cannot be + retrieved from a site set in O(1) complexity so the site + set does not feature the 'nsites' methods. + */ struct unknown : any { std::string name() const { return "nsites::unknown"; } }; - /// Property that states that a site set features the method - /// 'nsites' because the number of sites is known so its - /// retrieval has O(1) complexity. + /*! + \internal + \brief Property that states that a site set features the method + 'nsites' because the number of sites is known so its + retrieval has O(1) complexity. + */ struct known : any { std::string name() const { return "nsites::known"; } }; }; - /// Site set property about the 'bbox' method presence. + /*! + \internal + \brief Site set property about the 'bbox' method presence. + */ struct bbox { - /// Base class for the site set 'bbox' property. + /*! + \internal + \brief Base class for the site set 'bbox' property. + */ struct any { protected: any() {} }; - /// Property that states that the bounding box of a site set - /// is not featured as a method. This is either because the - /// notion of bounding box is meaningless for the site set - /// type, or because the bounding box cannot be retrieved in - /// O(1) complexity. + /*! + \internal + Property that states that the bounding box of a site set + is not featured as a method. This is either because the + notion of bounding box is meaningless for the site set + type, or because the bounding box cannot be retrieved in + O(1) complexity. + */ struct unknown : any { std::string name() const { return "bbox::unknown"; } }; - /// Property that states that the bounding box of a site set - /// is featured by the 'bbox' method. It means that the - /// notion of bounding box makes sense and that such a piece - /// of information can be retrieved in O(1) complexity. - /// Warning: this property is pseudo-abstract. The more - /// precise properties are 'lazy' and 'straight'. + /*! + \internal + Property that states that the bounding box of a site set + is featured by the 'bbox' method. It means that the + notion of bounding box makes sense and that such a piece + of information can be retrieved in O(1) complexity. + Warning: this property is pseudo-abstract. The more + precise properties are 'lazy' and 'straight'. + */ struct known : any { protected: known() {} }; - /// Property that states that the bounding box of a site set - /// is computed by the site set in a lazy way. + /*! + \internal + Property that states that the bounding box of a site set + is computed by the site set in a lazy way. + */ struct lazy : known { std::string name() const { return "bbox::lazy"; } }; - /// Property that states that the bounding box of a site set - /// is always kept up to date by the site set. + /*! + \internal + Property that states that the bounding box of a site set + is always kept up to date by the site set. + */ struct straight : known { std::string name() const { return "bbox::straight"; } }; }; - /// Site set property about how the contents can evolve. + /*! + \internal + \brief Site set property about how the contents can evolve. + */ struct contents { - /// Base class for the site set 'contents' property. + /*! + \internal + \brief Base class for the site set 'contents' property. + */ struct any { protected: any() {} }; struct fixed : any { std::string name() const { return "contents::fixed"; } }; struct dynamic : any { protected: dynamic() {} }; @@ -145,11 +187,17 @@ namespace mln struct free : dynamic { std::string name() const { return "contents::free"; } }; }; - /// Site set property about the unicity or multiplicity of its - /// elements. + /*! + \internal + \brief Site set property about the unicity or multiplicity of its + elements. + */ struct arity { - /// Base class for the site set 'arity' property. + /*! + \internal + \brief Base class for the site set 'arity' property. + */ struct any { protected: any() {} }; struct unique : any { std::string name() const { return "arity::unique"; } }; struct multiple : any { std::string name() const { return "arity::multiple"; } }; diff --git a/milena/mln/trait/site_sets.hh b/milena/mln/trait/site_sets.hh index 64b304e..32512cd 100644 --- a/milena/mln/trait/site_sets.hh +++ b/milena/mln/trait/site_sets.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -59,7 +60,10 @@ namespace mln namespace trait { - /// Pack of 'undefined' type values for properties of site sets. + /*! + \internal + \brief Pack of 'undefined' type values for properties of site sets. + */ template <typename I> struct undefined_site_set_ { @@ -70,14 +74,16 @@ namespace mln }; - /*! \brief The trait pack structure for properties of site sets. - * - * This structure is specialized for every concrete class of site - * set so that properties are properly defined. - * - * \see mln::doc::Site_Set for the documentation of the "site set" - * concept. - */ + /*! + \internal + \brief The trait pack structure for properties of site sets. + + This structure is specialized for every concrete class of site + set so that properties are properly defined. + + \see mln::doc::Site_Set for the documentation of the "site set" + concept. + */ template <typename I> struct site_set_ : undefined_site_set_<I> { diff --git a/milena/mln/trait/solve.hh b/milena/mln/trait/solve.hh index 1a415e3..8ec6857 100644 --- a/milena/mln/trait/solve.hh +++ b/milena/mln/trait/solve.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2006, 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2006, 2007, 2008, 2009, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -42,7 +43,7 @@ // FIXME: Just for the record (use it...) -# ifndef MLN_DEBUG_TRAITS +# ifndef MLN_DEBUG_TRAITS # endif // ! MLN_DEBUG_TRAITS @@ -60,13 +61,22 @@ namespace mln namespace trait { - /// Flag type for a not found trait. + /*! + \internal + \brief Flag type for a not found trait. + */ struct not_found {}; - /// Flag type for an undefined trait. + /*! + \internal + \brief Flag type for an undefined trait. + */ struct undefined {}; - /// Flag type for a trait that is multiply undefined. + /*! + \internal + \brief Flag type for a trait that is multiply undefined. + */ struct multiply_defined {}; @@ -110,7 +120,7 @@ namespace mln typedef undefined ret; }; - + template < template <class, class> class Name, template <class> class Category_L, typename L, template <class> class Category_R, typename R > diff --git a/milena/mln/trait/window/props.hh b/milena/mln/trait/window/props.hh index 1b40e47..ae2b901 100644 --- a/milena/mln/trait/window/props.hh +++ b/milena/mln/trait/window/props.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -75,50 +76,92 @@ namespace mln { - /// Window property about the 'size' method presence. + /*! + \internal + \brief Window property about the 'size' method presence. + */ struct size { - /// Base class for the window 'size' property. + /*! + \internal + \brief Base class for the window 'size' property. + */ struct any { protected: any() {} }; - /// Property that states that the size is fixed. + /*! + \internal + \brief Property that states that the size is fixed. + */ struct fixed : any { std::string name() const { return "size::fixed"; } }; - /// Property that states that the size is not fixed so unknown. + /*! + \internal + \brief Property that states that the size is not fixed so unknown. + */ struct unknown : any { std::string name() const { return "size::unknown"; } }; }; - /// Window property about the 'support' it is designed for. + /*! + \internal + \brief Window property about the 'support' it is designed for. + */ struct support { - /// Base class for the window 'support' property. + /*! + \internal + \brief Base class for the window 'support' property. + */ struct any { protected: any() {} }; - /// Property that states that the window is designed for a regular support. + /*! + \internal + \brief Property that states that the window is designed for a regular support. + */ struct regular : any { std::string name() const { return "support::regular"; } }; - /// Property that states that the window is not designed for a regular support. + /*! + \internal + \brief Property that states that the window is not designed for a regular support. + */ struct irregular : any { std::string name() const { return "support::irregular"; } }; }; - /// Window property about how the window is defined. + /*! + \internal + \brief Window property about how the window is defined. + */ struct definition { - /// Base class for the window 'definition' property. + /*! + \internal + \brief Base class for the window 'definition' property. + */ struct any { protected: any() {} }; - /// Property that states that the definition is unique. + /*! + \internal + \brief Property that states that the definition is unique. + */ struct unique : any { std::string name() const { return "definition::unique"; } }; - /// Abstract property that states that the definition is multiple. + /*! + \internal + \brief Abstract property that states that the definition is multiple. + */ struct multiple : any { protected: multiple() {} }; - /// Property that states that this window has n definitions. + /*! + \internal + \brief Property that states that this window has n definitions. + */ struct n_ary : multiple { std::string name() const { return "definition::n_ary"; } }; - /// Property that states that this window has a varying definition. + /*! + \internal + \brief Property that states that this window has a varying definition. + */ struct varying : multiple { std::string name() const { return "definition::varying"; } }; }; diff --git a/milena/mln/trait/windows.hh b/milena/mln/trait/windows.hh index 2a77470..feec278 100644 --- a/milena/mln/trait/windows.hh +++ b/milena/mln/trait/windows.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -68,7 +69,10 @@ namespace mln namespace trait { - /// Pack of 'undefined' type values for properties of windows. + /*! + \internal + \brief Pack of 'undefined' type values for properties of windows. + */ template <typename W> struct undefined_window_ { @@ -78,13 +82,15 @@ namespace mln }; - /*! \brief The trait pack structure for properties of windows. - * - * This structure is specialized for every concrete class of site - * set so that properties are properly defined. - * - * \see mln::doc::Window for the documentation of the "window" - * concept. + /*! + \internal + \brief The trait pack structure for properties of windows. + + This structure is specialized for every concrete class of site + set so that properties are properly defined. + + \see mln::doc::Window for the documentation of the "window" + concept. */ template <typename W> struct window_ : undefined_window_<W> @@ -92,7 +98,10 @@ namespace mln }; - // \internal Trait for classical windows. + /*! + \internal + \brief Trait for classical windows. + */ struct classical_window_ { typedef mln::trait::window::size::fixed size; diff --git a/milena/mln/util/branch_iter.hh b/milena/mln/util/branch_iter.hh index 30b2faf..42cec57 100644 --- a/milena/mln/util/branch_iter.hh +++ b/milena/mln/util/branch_iter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -42,12 +43,14 @@ namespace mln namespace util { - /*! \brief Basic 2D image class. - * - * The parameter \c T is the type of node's data. branch_iter is - * used to pre-order walk a branch. - * - */ + /*! + \internal + \brief Iterator on branch. + + The parameter \c T is the type of node's data. branch_iter is + used to pre-order walk a branch. + + */ template <typename T> class branch_iter { diff --git a/milena/mln/util/branch_iter_ind.hh b/milena/mln/util/branch_iter_ind.hh index 9cb2568..501d332 100644 --- a/milena/mln/util/branch_iter_ind.hh +++ b/milena/mln/util/branch_iter_ind.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -56,12 +57,14 @@ namespace mln int pos_; }; - /*! \brief Basic 2D image class. - * - * The parameter \c T is the type of node's data. branch_iter_ind - * is used to pre-order walk a branch. - * - */ + /*! + \internal + \brief Iterator on branch. + + The parameter \c T is the type of node's data. branch_iter_ind + is used to pre-order walk a branch. + + */ template <typename T> class branch_iter_ind { diff --git a/milena/mln/util/edge.hh b/milena/mln/util/edge.hh index 75a82c9..bf5acf5 100644 --- a/milena/mln/util/edge.hh +++ b/milena/mln/util/edge.hh @@ -175,7 +175,10 @@ namespace mln namespace internal { - /// subject_impl specialization (Proxy). + /*! + \internal + \brief subject_impl specialization (Proxy). + */ /// \{ template <typename G, typename E> diff --git a/milena/mln/util/graph.hh b/milena/mln/util/graph.hh index 54d1c76..bf31e58 100644 --- a/milena/mln/util/graph.hh +++ b/milena/mln/util/graph.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2012 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -48,7 +48,10 @@ namespace mln namespace internal { - /// Data structure for mln::util::graph. + /*! + \internal + \brief Data structure for mln::util::graph. + */ template <> struct data<util::graph> { diff --git a/milena/mln/util/internal/edge_impl.hh b/milena/mln/util/internal/edge_impl.hh index ca5b5fa..695eeeb 100644 --- a/milena/mln/util/internal/edge_impl.hh +++ b/milena/mln/util/internal/edge_impl.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +44,10 @@ namespace mln namespace internal { - /// Implementation class to equip generalized edge classes. + /*! + \internal + \brief Implementation class to equip generalized edge classes. + */ template <typename G> class edge_impl_ { @@ -51,28 +55,18 @@ namespace mln edge_impl_(); }; - } // end of namespace internal - - } // end of namespace util - -} // end of namespace mln #ifndef MLN_INCLUDE_ONLY -namespace mln -{ - namespace util - { + template <typename G> + inline + edge_impl_<G>::edge_impl_() + { + } - namespace internal - { +#endif // ! MLN_INCLUDE_ONLY - template <typename G> - inline - edge_impl_<G>::edge_impl_() - { - } } // end of namespace internal @@ -80,7 +74,5 @@ namespace mln } // end of namespace mln -#endif // ! MLN_INCLUDE_ONLY - #endif // ! MLN_UTIL_INTERNAL_EDGE_IMPL_HH diff --git a/milena/mln/util/internal/graph_base.hh b/milena/mln/util/internal/graph_base.hh index 3a9eea9..0297465 100644 --- a/milena/mln/util/internal/graph_base.hh +++ b/milena/mln/util/internal/graph_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -60,7 +60,10 @@ namespace mln namespace internal { - /// \brief Base class for undirected graphs. + /*! + \internal + \brief Base class for undirected graphs. + */ template<typename E> class graph_base : public Graph<E> { diff --git a/milena/mln/util/internal/graph_iter.hh b/milena/mln/util/internal/graph_iter.hh index 09e0bb4..6ebd627 100644 --- a/milena/mln/util/internal/graph_iter.hh +++ b/milena/mln/util/internal/graph_iter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -42,8 +43,10 @@ namespace mln namespace internal { - /// Forward vertex iterator. - + /*! + \internal + \brief Forward vertex iterator. + */ template<typename G> class vertex_fwd_iterator : public graph_iter_base<G, util::vertex<G>, vertex_fwd_iterator<G> > @@ -70,8 +73,10 @@ namespace mln }; - /// Backward vertex iterator. - + /*! + \internal + \brief Backward vertex iterator. + */ template<typename G> class vertex_bkd_iterator : public graph_iter_base<G, util::vertex<G>, vertex_bkd_iterator<G> > @@ -98,8 +103,10 @@ namespace mln }; - /// Forward edge iterator. - + /*! + \internal + \brief Forward edge iterator. + */ template <typename G> class edge_fwd_iterator : public graph_iter_base<G, util::edge<G>, edge_fwd_iterator<G> > @@ -126,8 +133,10 @@ namespace mln }; - /// Backward edge iterator. - + /*! + \internal + \brief Backward edge iterator. + */ template <typename G> class edge_bkd_iterator : public graph_iter_base<G, util::edge<G>, edge_bkd_iterator<G> > diff --git a/milena/mln/util/internal/vertex_impl.hh b/milena/mln/util/internal/vertex_impl.hh index 754075e..04af289 100644 --- a/milena/mln/util/internal/vertex_impl.hh +++ b/milena/mln/util/internal/vertex_impl.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +44,10 @@ namespace mln namespace internal { - /// Implementation class to equip generalized vertex classes. + /*! + \internal + \brief Implementation class to equip generalized vertex classes. + */ template <typename G> class vertex_impl_ { @@ -51,22 +55,9 @@ namespace mln vertex_impl_(); }; - } // end of namespace internal - - } // end of namespace util - -} // end of namespace mln #ifndef MLN_INCLUDE_ONLY -namespace mln -{ - - namespace util - { - - namespace internal - { template <typename G> inline @@ -74,13 +65,13 @@ namespace mln { } + +#endif // ! MLN_INCLUDE_ONLY + } // end of namespace internal } // end of namespace util } // end of namespace mln -#endif // ! MLN_INCLUDE_ONLY - - #endif // ! MLN_UTIL_INTERNAL_VERTEX_IMPL_HH diff --git a/milena/mln/util/lemmings.hh b/milena/mln/util/lemmings.hh index c6d74b2..4aaefac 100644 --- a/milena/mln/util/lemmings.hh +++ b/milena/mln/util/lemmings.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,8 +41,7 @@ namespace mln { /*! \brief Lemmings tool. - * - */ + */ template <typename I> struct lemmings_ : public Object< lemmings_<I> > { diff --git a/milena/mln/util/line_graph.hh b/milena/mln/util/line_graph.hh index f8104a4..f5b68af 100644 --- a/milena/mln/util/line_graph.hh +++ b/milena/mln/util/line_graph.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -50,7 +50,10 @@ namespace mln namespace internal { - /// Data structure for mln::util::line_graph<G>. + /*! + \internal + \brief Data structure for mln::util::line_graph<G>. + */ template <typename G> struct data< util::line_graph<G> > { diff --git a/milena/mln/util/site_pair.hh b/milena/mln/util/site_pair.hh index 52cb75d..4dee2fd 100644 --- a/milena/mln/util/site_pair.hh +++ b/milena/mln/util/site_pair.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -97,8 +98,10 @@ namespace mln { /// \{ - /// subject_impl specialization (Proxy) - + /*! + \internal + \brief subject_impl specialization (Proxy) + */ template <typename P, typename E> struct subject_impl< const util::site_pair<P>, E > { diff --git a/milena/mln/util/vertex.hh b/milena/mln/util/vertex.hh index 4f5f1b2..2cbdaa1 100644 --- a/milena/mln/util/vertex.hh +++ b/milena/mln/util/vertex.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010 EPITA Research and Development +// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -165,7 +165,10 @@ namespace mln namespace internal { - /// subject_impl specialization (Proxy). + /*! + \internal + \brief subject_impl specialization (Proxy). + */ /// \{ template <typename G, typename E> diff --git a/milena/mln/value/internal/value_like.hh b/milena/mln/value/internal/value_like.hh index e3988d4..28dfc38 100644 --- a/milena/mln/value/internal/value_like.hh +++ b/milena/mln/value/internal/value_like.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -43,10 +44,14 @@ namespace mln namespace internal { - /// Base class for value classes defined over another - /// type. Parameters are \c V the equivalent value type and - /// \c E the exact value type. - /// + /*! + \internal + \brief Base class for value classes defined over another + type. + + Parameters are \c V the equivalent value type and + \c E the exact value type. + */ template < typename V, // Equivalent. typename C, // Encoding. typename N, // Interoperation. diff --git a/milena/mln/value/viter.hh b/milena/mln/value/viter.hh index 308e0de..8d9434d 100644 --- a/milena/mln/value/viter.hh +++ b/milena/mln/value/viter.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -44,10 +45,12 @@ namespace mln { - /*! \brief FIXME: Forward iterator on a set of values. - * - * The parameter \c S is the type of value set. - */ + /*! + \internal + \brief FIXME: Forward iterator on a set of values. + + The parameter \c S is the type of value set. + */ template <typename S> struct fwd_viter_ : public Value_Iterator< fwd_viter_<S> > { @@ -89,10 +92,12 @@ namespace mln - /*! \brief FIXME: Backward iterator on a set of values. - * - * The parameter \c S is the type of value set. - */ + /*! + \internal + \brief FIXME: Backward iterator on a set of values. + + The parameter \c S is the type of value set. + */ template <typename S> struct bkd_viter_ : public Value_Iterator< bkd_viter_<S> > { -- 1.7.2.5