April 2013 - Olena-patches

branch swilena updated: olena-2.0-144-gdde0e23
by git＠lrde.epita.fr 11 Apr '13

11 Apr '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch swilena has been updated via dde0e23d75e77e157992b656322044fad5c1f9e1 (commit) from bc91dfb5dd05ce8b4f6b68f7f4eec1926b3aef0f (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- dde0e23 Make fld tests write in different files. ----------------------------------------------------------------------- Summary of changes: milena/ChangeLog | 9 +++++++++ milena/tests/io/fld/fld1d.cc | 9 +++++---- milena/tests/io/fld/fld2d.cc | 21 +++++++++++---------- milena/tests/io/fld/fld3d.cc | 9 +++++---- 4 files changed, 30 insertions(+), 18 deletions(-) hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

branch unstable/scribo updated: olena-2.0-473-g6750f67
by git＠lrde.epita.fr 11 Apr '13

11 Apr '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch unstable/scribo has been updated via 6750f67b683f4d2a3d77f2413f8282466806807b (commit) via 26b7669e890316c16cdf04ef1ccd8bdcd68b00f1 (commit) via af9984876b7de257a610bfddec7b20235b026850 (commit) via a35bff38b91abc202b9a18ba45922423c3c85662 (commit) from 5a67b47545170fd6ad5ce94bd1cb5b7edca55e9b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- 6750f67 Reference value types documentation in Values group. 26b7669 Add a PDF I/O group in documentation. af99848 Add references to code examples a35bff3 Hide internal API and classes in documentation. ----------------------------------------------------------------------- Summary of changes: milena/ChangeLog | 164 ++++++++++++++++++++ milena/doc/Doxyfile.in | 51 ++++++- milena/doc/DoxygenLayout.xml | 2 +- milena/doc/examples.dox | 11 +- milena/doc/mln/io/io.dox | 7 + milena/doc/mln/value/hsl.dox | 37 +++++ milena/doc/mln/value/int_s16.dox | 24 +++ milena/doc/mln/value/int_s24.dox | 24 +++ milena/doc/mln/value/int_s32.dox | 24 +++ milena/doc/mln/value/int_s8.dox | 24 +++ milena/doc/mln/value/int_u12.dox | 24 +++ milena/doc/mln/value/int_u16.dox | 24 +++ milena/doc/mln/value/int_u24.dox | 24 +++ milena/doc/mln/value/int_u32.dox | 24 +++ milena/doc/mln/value/int_u8.dox | 24 +++ milena/doc/mln/value/label_16.dox | 21 +++ milena/doc/mln/value/label_32.dox | 21 +++ milena/doc/mln/value/label_8.dox | 21 +++ milena/doc/mln/value/rgb16.dox | 69 ++++++++ milena/doc/mln/value/rgb8.dox | 69 ++++++++ milena/doc/mln/value/value.dox | 43 +++++ milena/mln/core/alias/vec2d.hh | 2 +- milena/mln/core/alias/vec3d.hh | 2 +- milena/mln/core/box_runend_piter.hh | 11 +- milena/mln/core/box_runstart_piter.hh | 8 + milena/mln/core/dpoints_pixter.hh | 16 ++- milena/mln/core/dpsites_piter.hh | 14 ++- milena/mln/core/faces_psite.hh | 7 +- milena/mln/core/image/ch_piter.hh | 6 +- milena/mln/core/image/complex_image.hh | 8 +- .../mln/core/image/complex_neighborhood_piter.hh | 6 +- milena/mln/core/image/complex_window_piter.hh | 6 +- milena/mln/core/image/dmorph/extended.hh | 10 +- milena/mln/core/image/dmorph/extension_fun.hh | 11 +- milena/mln/core/image/dmorph/extension_ima.hh | 10 +- milena/mln/core/image/dmorph/extension_val.hh | 9 +- milena/mln/core/image/dmorph/hexa.hh | 9 +- milena/mln/core/image/dmorph/hexa_piter.hh | 7 +- milena/mln/core/image/dmorph/image_if.hh | 7 +- milena/mln/core/image/dmorph/p2p_image.hh | 5 +- milena/mln/core/image/dmorph/slice_image.hh | 7 +- milena/mln/core/image/dmorph/sub_image.hh | 11 +- milena/mln/core/image/dmorph/sub_image_if.hh | 8 +- milena/mln/core/image/dmorph/transformed_image.hh | 5 +- milena/mln/core/image/dmorph/unproject_image.hh | 7 +- milena/mln/core/image/edge_image.hh | 9 +- milena/mln/core/image/flat_image.hh | 12 +- milena/mln/core/image/graph_window_if_piter.hh | 13 +- milena/mln/core/image/graph_window_piter.hh | 10 +- milena/mln/core/image/image1d.hh | 10 +- milena/mln/core/image/image2d.hh | 26 ++-- milena/mln/core/image/image3d.hh | 14 ++- milena/mln/core/image/imorph/decorated_image.hh | 9 +- milena/mln/core/image/imorph/interpolated.hh | 7 +- milena/mln/core/image/imorph/labeled_image.hh | 11 +- milena/mln/core/image/imorph/lazy_image.hh | 5 +- milena/mln/core/image/imorph/plain.hh | 5 +- milena/mln/core/image/imorph/safe.hh | 5 +- milena/mln/core/image/imorph/tr_image.hh | 5 +- milena/mln/core/image/vertex_image.hh | 7 +- milena/mln/core/image/vmorph/cast_image.hh | 7 +- milena/mln/core/image/vmorph/fun_image.hh | 5 +- milena/mln/core/image/vmorph/thru_image.hh | 7 +- milena/mln/core/image/vmorph/violent_cast_image.hh | 5 +- milena/mln/core/internal/classical_window_base.hh | 5 +- milena/mln/core/internal/graph_psite_base.hh | 5 +- milena/mln/core/internal/image_base.hh | 15 +- milena/mln/core/internal/image_identity.hh | 5 +- milena/mln/core/internal/image_morpher.hh | 13 +- milena/mln/core/internal/labeled_image_base.hh | 4 +- milena/mln/core/internal/neighb_base.hh | 8 +- milena/mln/core/internal/neighb_niter_base.hh | 8 +- milena/mln/core/internal/p_complex_piter_base.hh | 5 +- milena/mln/core/internal/piter_adaptor.hh | 13 +- milena/mln/core/internal/pseudo_site_base.hh | 3 +- milena/mln/core/internal/run_image.hh | 5 +- milena/mln/core/internal/set_of.hh | 5 +- milena/mln/core/internal/site_iterator_base.hh | 7 +- .../core/internal/site_relative_iterator_base.hh | 9 +- milena/mln/core/internal/site_set_base.hh | 5 +- milena/mln/core/internal/site_set_impl.hh | 3 +- milena/mln/core/internal/site_set_iterator_base.hh | 12 +- milena/mln/core/internal/window_base.hh | 12 +- milena/mln/core/mixed_neighb.hh | 11 +- milena/mln/core/neighb.hh | 10 +- milena/mln/core/pixter1d.hh | 8 +- milena/mln/core/pixter2d.hh | 12 ++- milena/mln/core/pixter3d.hh | 10 +- milena/mln/core/point.hh | 12 +- milena/mln/core/routine/init.hh | 3 +- milena/mln/core/site_set/box.hh | 3 +- milena/mln/core/site_set/box_piter.hh | 10 +- milena/mln/core/site_set/complex_psite.hh | 14 ++- milena/mln/core/site_set/p_array.hh | 25 +++- milena/mln/core/site_set/p_centered.hh | 6 +- milena/mln/core/site_set/p_complex_piter.hh | 6 +- milena/mln/core/site_set/p_double.hh | 15 ++- milena/mln/core/site_set/p_edges_psite.hh | 6 +- milena/mln/core/site_set/p_faces.hh | 4 +- milena/mln/core/site_set/p_graph_piter.hh | 9 +- milena/mln/core/site_set/p_if.hh | 5 +- milena/mln/core/site_set/p_if_piter.hh | 7 +- milena/mln/core/site_set/p_image.hh | 11 +- milena/mln/core/site_set/p_key.hh | 10 +- milena/mln/core/site_set/p_line2d.hh | 3 +- milena/mln/core/site_set/p_mutable_array_of.hh | 10 +- milena/mln/core/site_set/p_priority.hh | 8 +- milena/mln/core/site_set/p_run.hh | 7 +- milena/mln/core/site_set/p_run_piter.hh | 10 +- milena/mln/core/site_set/p_set_of.hh | 7 +- milena/mln/core/site_set/p_transformed.hh | 6 +- milena/mln/core/site_set/p_transformed_piter.hh | 7 +- milena/mln/core/site_set/p_vaccess.hh | 6 +- milena/mln/core/site_set/p_vertices_psite.hh | 6 +- milena/mln/core/w_window.hh | 11 +- milena/mln/core/window.hh | 8 +- milena/mln/io/pdf/get_header.hh | 10 +- milena/mln/io/pdf/load.hh | 12 ++ milena/mln/util/array.hh | 20 ++-- milena/mln/value/hsl.hh | 24 +++- milena/mln/value/int_s.hh | 9 +- milena/mln/value/int_s16.hh | 15 ++- milena/mln/value/int_s24.hh | 15 ++- milena/mln/value/int_s32.hh | 15 ++- milena/mln/value/int_s8.hh | 16 ++- milena/mln/value/int_u.hh | 12 +- milena/mln/value/int_u12.hh | 15 ++- milena/mln/value/int_u16.hh | 15 ++- milena/mln/value/int_u24.hh | 15 ++- milena/mln/value/int_u32.hh | 15 ++- milena/mln/value/int_u8.hh | 15 ++- milena/mln/value/label.hh | 15 +- milena/mln/value/label_16.hh | 15 ++- milena/mln/value/label_32.hh | 9 +- milena/mln/value/label_8.hh | 15 ++- milena/mln/value/qt/rgb32.hh | 15 ++- milena/mln/value/rgb.hh | 10 +- milena/mln/value/rgb16.hh | 17 ++- milena/mln/value/rgb8.hh | 17 ++- 139 files changed, 1509 insertions(+), 351 deletions(-) create mode 100644 milena/doc/mln/value/hsl.dox create mode 100644 milena/doc/mln/value/int_s16.dox create mode 100644 milena/doc/mln/value/int_s24.dox create mode 100644 milena/doc/mln/value/int_s32.dox create mode 100644 milena/doc/mln/value/int_s8.dox create mode 100644 milena/doc/mln/value/int_u12.dox create mode 100644 milena/doc/mln/value/int_u16.dox create mode 100644 milena/doc/mln/value/int_u24.dox create mode 100644 milena/doc/mln/value/int_u32.dox create mode 100644 milena/doc/mln/value/int_u8.dox create mode 100644 milena/doc/mln/value/label_16.dox create mode 100644 milena/doc/mln/value/label_32.dox create mode 100644 milena/doc/mln/value/label_8.dox create mode 100644 milena/doc/mln/value/rgb16.dox create mode 100644 milena/doc/mln/value/rgb8.dox create mode 100644 milena/doc/mln/value/value.dox hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena-2.0-473-g6750f67 Reference value types documentation in Values group.
by Guillaume Lazzara 11 Apr '13

11 Apr '13

* doc/mln/value/hsl.dox, * doc/mln/value/int_s16.dox, * doc/mln/value/int_s24.dox, * doc/mln/value/int_s32.dox, * doc/mln/value/int_s8.dox, * doc/mln/value/int_u12.dox, * doc/mln/value/int_u16.dox, * doc/mln/value/int_u24.dox, * doc/mln/value/int_u32.dox, * doc/mln/value/int_u8.dox, * doc/mln/value/label_16.dox, * doc/mln/value/label_32.dox, * doc/mln/value/label_8.dox, * doc/mln/value/rgb16.dox, * doc/mln/value/rgb8.dox, * doc/mln/value/value.dox: New. * mln/value/hsl.hh, * mln/value/int_s.hh, * mln/value/int_s16.hh, * mln/value/int_s24.hh, * mln/value/int_s32.hh, * mln/value/int_s8.hh, * mln/value/int_u.hh, * mln/value/int_u12.hh, * mln/value/int_u16.hh, * mln/value/int_u24.hh, * mln/value/int_u32.hh, * mln/value/int_u8.hh, * mln/value/label.hh, * mln/value/label_16.hh, * mln/value/label_32.hh, * mln/value/label_8.hh, * mln/value/qt/rgb32.hh, * mln/value/rgb.hh, * mln/value/rgb16.hh, * mln/value/rgb8.hh: Hide aliases. --- milena/ChangeLog | 42 ++++++++++++++++++++++ milena/doc/mln/value/hsl.dox | 37 ++++++++++++++++++++ milena/doc/mln/value/int_s16.dox | 24 +++++++++++++ milena/doc/mln/value/int_s24.dox | 24 +++++++++++++ milena/doc/mln/value/int_s32.dox | 24 +++++++++++++ milena/doc/mln/value/int_s8.dox | 24 +++++++++++++ milena/doc/mln/value/int_u12.dox | 24 +++++++++++++ milena/doc/mln/value/int_u16.dox | 24 +++++++++++++ milena/doc/mln/value/int_u24.dox | 24 +++++++++++++ milena/doc/mln/value/int_u32.dox | 24 +++++++++++++ milena/doc/mln/value/int_u8.dox | 24 +++++++++++++ milena/doc/mln/value/label_16.dox | 21 +++++++++++ milena/doc/mln/value/label_32.dox | 21 +++++++++++ milena/doc/mln/value/label_8.dox | 21 +++++++++++ milena/doc/mln/value/rgb16.dox | 69 +++++++++++++++++++++++++++++++++++++ milena/doc/mln/value/rgb8.dox | 69 +++++++++++++++++++++++++++++++++++++ milena/doc/mln/value/value.dox | 43 +++++++++++++++++++++++ milena/mln/value/hsl.hh | 24 ++++++++++++- milena/mln/value/int_s.hh | 9 +++-- milena/mln/value/int_s16.hh | 15 +++++++- milena/mln/value/int_s24.hh | 15 +++++++- milena/mln/value/int_s32.hh | 15 +++++++- milena/mln/value/int_s8.hh | 16 +++++++- milena/mln/value/int_u.hh | 12 ++++-- milena/mln/value/int_u12.hh | 15 +++++++- milena/mln/value/int_u16.hh | 15 +++++++- milena/mln/value/int_u24.hh | 15 +++++++- milena/mln/value/int_u32.hh | 15 +++++++- milena/mln/value/int_u8.hh | 15 +++++++- milena/mln/value/label.hh | 15 +++++--- milena/mln/value/label_16.hh | 15 +++++++- milena/mln/value/label_32.hh | 9 ++++- milena/mln/value/label_8.hh | 15 +++++++- milena/mln/value/qt/rgb32.hh | 15 ++++++-- milena/mln/value/rgb.hh | 10 ++++-- milena/mln/value/rgb16.hh | 17 +++++++-- milena/mln/value/rgb8.hh | 17 +++++++-- 37 files changed, 782 insertions(+), 51 deletions(-) create mode 100644 milena/doc/mln/value/hsl.dox create mode 100644 milena/doc/mln/value/int_s16.dox create mode 100644 milena/doc/mln/value/int_s24.dox create mode 100644 milena/doc/mln/value/int_s32.dox create mode 100644 milena/doc/mln/value/int_s8.dox create mode 100644 milena/doc/mln/value/int_u12.dox create mode 100644 milena/doc/mln/value/int_u16.dox create mode 100644 milena/doc/mln/value/int_u24.dox create mode 100644 milena/doc/mln/value/int_u32.dox create mode 100644 milena/doc/mln/value/int_u8.dox create mode 100644 milena/doc/mln/value/label_16.dox create mode 100644 milena/doc/mln/value/label_32.dox create mode 100644 milena/doc/mln/value/label_8.dox create mode 100644 milena/doc/mln/value/rgb16.dox create mode 100644 milena/doc/mln/value/rgb8.dox create mode 100644 milena/doc/mln/value/value.dox diff --git a/milena/ChangeLog b/milena/ChangeLog index fa1c5b8..f39b9d7 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,47 @@ 2013-04-11 Guillaume Lazzara <z(a)lrde.epita.fr> + Reference value types documentation in Values group. + + * doc/mln/value/hsl.dox, + * doc/mln/value/int_s16.dox, + * doc/mln/value/int_s24.dox, + * doc/mln/value/int_s32.dox, + * doc/mln/value/int_s8.dox, + * doc/mln/value/int_u12.dox, + * doc/mln/value/int_u16.dox, + * doc/mln/value/int_u24.dox, + * doc/mln/value/int_u32.dox, + * doc/mln/value/int_u8.dox, + * doc/mln/value/label_16.dox, + * doc/mln/value/label_32.dox, + * doc/mln/value/label_8.dox, + * doc/mln/value/rgb16.dox, + * doc/mln/value/rgb8.dox, + * doc/mln/value/value.dox: New. + + * mln/value/hsl.hh, + * mln/value/int_s.hh, + * mln/value/int_s16.hh, + * mln/value/int_s24.hh, + * mln/value/int_s32.hh, + * mln/value/int_s8.hh, + * mln/value/int_u.hh, + * mln/value/int_u12.hh, + * mln/value/int_u16.hh, + * mln/value/int_u24.hh, + * mln/value/int_u32.hh, + * mln/value/int_u8.hh, + * mln/value/label.hh, + * mln/value/label_16.hh, + * mln/value/label_32.hh, + * mln/value/label_8.hh, + * mln/value/qt/rgb32.hh, + * mln/value/rgb.hh, + * mln/value/rgb16.hh, + * mln/value/rgb8.hh: Hide aliases. + +2013-04-11 Guillaume Lazzara <z(a)lrde.epita.fr> + Add a PDF I/O group in documentation. * doc/mln/io/io.dox: Add PDF group. diff --git a/milena/doc/mln/value/hsl.dox b/milena/doc/mln/value/hsl.dox new file mode 100644 index 0000000..d05f9d8 --- /dev/null +++ b/milena/doc/mln/value/hsl.dox @@ -0,0 +1,37 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct hsl_f + : hsl_<float,float,float> + { + public: + /// Constructor without argument. + hsl_f(); + + /// Contruct a HSL color with (0,0,0) as value. + hsl_f(const literal::zero_t&); + + /// Constructor from component values. + hsl_f(const H& hue, const S& sat, const L& lum); + }; + + struct hsl_d + : hsl_<double,double,double> + { + public: + /// Constructor without argument. + hsl_d(); + + /// Contruct a HSL color with (0,0,0) as value. + hsl_d(const literal::zero_t&); + + /// Constructor from component values. + hsl_d(const H& hue, const S& sat, const L& lum); + }; + + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_s16.dox b/milena/doc/mln/value/int_s16.dox new file mode 100644 index 0000000..17e36c5 --- /dev/null +++ b/milena/doc/mln/value/int_s16.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_s16 + : public int_s<16> + { + public: + /// Constructor without argument. + int_s16(); + + /// Constructor from an integer. + int_s16(int i); + + /// Constructors with literals. Set to 0. + int_s16(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_s16(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_s24.dox b/milena/doc/mln/value/int_s24.dox new file mode 100644 index 0000000..76e11db --- /dev/null +++ b/milena/doc/mln/value/int_s24.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_s24 + : public int_s<24> + { + public: + /// Constructor without argument. + int_s24(); + + /// Constructor from an integer. + int_s24(int i); + + /// Constructors with literals. Set to 0. + int_s24(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_s24(const mln::literal::one_t&); + } + } +} diff --git a/milena/doc/mln/value/int_s32.dox b/milena/doc/mln/value/int_s32.dox new file mode 100644 index 0000000..1b6470f --- /dev/null +++ b/milena/doc/mln/value/int_s32.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_s32 + : public int_s<32> + { + public: + /// Constructor without argument. + int_s32(); + + /// Constructor from an integer. + int_s32(int i); + + /// Constructors with literals. Set to 0. + int_s32(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_s32(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_s8.dox b/milena/doc/mln/value/int_s8.dox new file mode 100644 index 0000000..d609612 --- /dev/null +++ b/milena/doc/mln/value/int_s8.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_s8 + : public int_s<8> + { + public: + /// Constructor without argument. + int_s8(); + + /// Constructor from an integer. + int_s8(int i); + + /// Constructors with literals. Set to 0. + int_s8(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_s8(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_u12.dox b/milena/doc/mln/value/int_u12.dox new file mode 100644 index 0000000..071d0e3 --- /dev/null +++ b/milena/doc/mln/value/int_u12.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_u12 + : public int_u<12> + { + public: + /// Constructor without argument. + int_u12(); + + /// Constructor from an integer. + int_u12(int i); + + /// Constructors with literals. Set to 0. + int_u12(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_u12(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_u16.dox b/milena/doc/mln/value/int_u16.dox new file mode 100644 index 0000000..cf3111f --- /dev/null +++ b/milena/doc/mln/value/int_u16.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_u16 + : public int_u<16> + { + public: + /// Constructor without argument. + int_u16(); + + /// Constructor from an integer. + int_u16(int i); + + /// Constructors with literals. Set to 0. + int_u16(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_u16(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_u24.dox b/milena/doc/mln/value/int_u24.dox new file mode 100644 index 0000000..c32b629 --- /dev/null +++ b/milena/doc/mln/value/int_u24.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_u24 + : public int_u<8> + { + public: + /// Constructor without argument. + int_u24(); + + /// Constructor from an integer. + int_u24(int i); + + /// Constructors with literals. Set to 0. + int_u24(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_u24(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_u32.dox b/milena/doc/mln/value/int_u32.dox new file mode 100644 index 0000000..baad8a0 --- /dev/null +++ b/milena/doc/mln/value/int_u32.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_u32 + : public int_u<32> + { + public: + /// Constructor without argument. + int_u32(); + + /// Constructor from an integer. + int_u32(int i); + + /// Constructors with literals. Set to 0. + int_u32(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_u32(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/int_u8.dox b/milena/doc/mln/value/int_u8.dox new file mode 100644 index 0000000..1b2e618 --- /dev/null +++ b/milena/doc/mln/value/int_u8.dox @@ -0,0 +1,24 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct int_u8 + : public int_u<8> + { + public: + /// Constructor without argument. + int_u8(); + + /// Constructor from an integer. + int_u8(int i); + + /// Constructors with literals. Set to 0. + int_u8(const mln::literal::zero_t&); + /// Constructors with literals. Set to 1. + int_u8(const mln::literal::one_t&); + } + } +} \ No newline at end of file diff --git a/milena/doc/mln/value/label_16.dox b/milena/doc/mln/value/label_16.dox new file mode 100644 index 0000000..5830723 --- /dev/null +++ b/milena/doc/mln/value/label_16.dox @@ -0,0 +1,21 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct label_16 + : label<16> + { + /// Constructor without argument. + label_16(); + + /// Constructor from an (unsigned) integer. + label_16(unsigned i); + + /// Constructor from literal::zero. + label_16(const literal::zero_t& v); + } + } +} diff --git a/milena/doc/mln/value/label_32.dox b/milena/doc/mln/value/label_32.dox new file mode 100644 index 0000000..1a72204 --- /dev/null +++ b/milena/doc/mln/value/label_32.dox @@ -0,0 +1,21 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct label_32 + : label<32> + { + /// Constructor without argument. + label_32(); + + /// Constructor from an (unsigned) integer. + label_32(unsigned i); + + /// Constructor from literal::zero. + label_32(const literal::zero_t& v); + } + } +} diff --git a/milena/doc/mln/value/label_8.dox b/milena/doc/mln/value/label_8.dox new file mode 100644 index 0000000..8b6ab3d --- /dev/null +++ b/milena/doc/mln/value/label_8.dox @@ -0,0 +1,21 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct label_8 + : label<8> + { + /// Constructor without argument. + label_8(); + + /// Constructor from an (unsigned) integer. + label_8(unsigned i); + + /// Constructor from literal::zero. + label_8(const literal::zero_t& v); + } + } +} diff --git a/milena/doc/mln/value/rgb16.dox b/milena/doc/mln/value/rgb16.dox new file mode 100644 index 0000000..f60d741 --- /dev/null +++ b/milena/doc/mln/value/rgb16.dox @@ -0,0 +1,69 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct rgb16 + : rgb<16> + { + public: + /// Constructor without argument. + rgb16(); + + /// Constructor from component values. + rgb16(int r, int g, int b); + + /// Constructor from a algebra::vec. + rgb16(const algebra::vec<3, int>& rhs); + /// Constructor from a algebra::vec. + rgb16(const algebra::vec<3, unsigned>& rhs); + /// Constructor from a algebra::vec. + rgb16(const algebra::vec<3, int_u<n> >& rhs); + /// Constructor from a algebra::vec. + rgb16(const algebra::vec<3, float>& rhs); + + /// Constructor from literal. rgb16(255,255,255) + rgb16(const mln::literal::white_t&); + /// Constructor from literal. rgb16(0,0,0) + rgb16(const mln::literal::black_t&); + + /// Constructor from literal. + rgb16(const mln::literal::light_gray_t&); + /// Constructor from literal. + rgb16(const mln::literal::medium_gray_t&); + /// Constructor from literal. + rgb16(const mln::literal::dark_gray_t&); + + /// Constructor from literal. + rgb16(const mln::literal::red_t&); + /// Constructor from literal. + rgb16(const mln::literal::blue_t&); + /// Constructor from literal. + rgb16(const mln::literal::green_t&); + /// Constructor from literal. + rgb16(const mln::literal::brown_t&); + /// Constructor from literal. + rgb16(const mln::literal::lime_t&); + /// Constructor from literal. + rgb16(const mln::literal::orange_t&); + /// Constructor from literal. + rgb16(const mln::literal::pink_t&); + /// Constructor from literal. + rgb16(const mln::literal::purple_t&); + /// Constructor from literal. + rgb16(const mln::literal::teal_t&); + /// Constructor from literal. + rgb16(const mln::literal::violet_t&); + /// Constructor from literal. + rgb16(const mln::literal::cyan_t&); + /// Constructor from literal. + rgb16(const mln::literal::magenta_t&); + /// Constructor from literal. + rgb16(const mln::literal::yellow_t&); + /// Constructor from literal. + rgb16(const mln::literal::olive_t&); + } + } +} diff --git a/milena/doc/mln/value/rgb8.dox b/milena/doc/mln/value/rgb8.dox new file mode 100644 index 0000000..5f5f7ab --- /dev/null +++ b/milena/doc/mln/value/rgb8.dox @@ -0,0 +1,69 @@ +// This file is necessary to help doxygen finding all the methods +// related to the corresponding typedef. + +namespace mln +{ + namespace value + { + struct rgb8 + : rgb<8> + { + public: + /// Constructor without argument. + rgb8(); + + /// Constructor from component values. + rgb8(int r, int g, int b); + + /// Constructor from a algebra::vec. + rgb8(const algebra::vec<3, int>& rhs); + /// Constructor from a algebra::vec. + rgb8(const algebra::vec<3, unsigned>& rhs); + /// Constructor from a algebra::vec. + rgb8(const algebra::vec<3, int_u<n> >& rhs); + /// Constructor from a algebra::vec. + rgb8(const algebra::vec<3, float>& rhs); + + /// Constructor from literal. rgb8(255,255,255) + rgb8(const mln::literal::white_t&); + /// Constructor from literal. rgb8(0,0,0) + rgb8(const mln::literal::black_t&); + + /// Constructor from literal. + rgb8(const mln::literal::light_gray_t&); + /// Constructor from literal. + rgb8(const mln::literal::medium_gray_t&); + /// Constructor from literal. + rgb8(const mln::literal::dark_gray_t&); + + /// Constructor from literal. + rgb8(const mln::literal::red_t&); + /// Constructor from literal. + rgb8(const mln::literal::blue_t&); + /// Constructor from literal. + rgb8(const mln::literal::green_t&); + /// Constructor from literal. + rgb8(const mln::literal::brown_t&); + /// Constructor from literal. + rgb8(const mln::literal::lime_t&); + /// Constructor from literal. + rgb8(const mln::literal::orange_t&); + /// Constructor from literal. + rgb8(const mln::literal::pink_t&); + /// Constructor from literal. + rgb8(const mln::literal::purple_t&); + /// Constructor from literal. + rgb8(const mln::literal::teal_t&); + /// Constructor from literal. + rgb8(const mln::literal::violet_t&); + /// Constructor from literal. + rgb8(const mln::literal::cyan_t&); + /// Constructor from literal. + rgb8(const mln::literal::magenta_t&); + /// Constructor from literal. + rgb8(const mln::literal::yellow_t&); + /// Constructor from literal. + rgb8(const mln::literal::olive_t&); + } + } +} diff --git a/milena/doc/mln/value/value.dox b/milena/doc/mln/value/value.dox new file mode 100644 index 0000000..9a97f24 --- /dev/null +++ b/milena/doc/mln/value/value.dox @@ -0,0 +1,43 @@ +/*! \defgroup valuegroup Values + * + * \brief All supported value types. + * + * \ingroup modtypes + */ + + +/*! \defgroup valuergb RGB + * + * \brief All supported RGB value types. + * + * \ingroup valuegroup + */ + + +/*! \defgroup valueuint Unsigned Integer + * + * \brief All supported unsigned integer value types. + * + * \ingroup valuegroup + */ + +/*! \defgroup valueint Integer + * + * \brief All supported integer value types. + * + * \ingroup valuegroup + */ + +/*! \defgroup valuelabel Labels + * + * \brief All supported Label value types. + * + * \ingroup valuegroup + */ + +/*! \defgroup valuehsl HSL + * + * \brief All supported HSL value types. + * + * \ingroup valuegroup + */ diff --git a/milena/mln/value/hsl.hh b/milena/mln/value/hsl.hh index 6f716f4..2cbcbe0 100644 --- a/milena/mln/value/hsl.hh +++ b/milena/mln/value/hsl.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -182,9 +182,29 @@ namespace mln // FIXME: Use float01_8/float01_16 ? + /*! + \class hsl_f + \headerfile <> + + \brief HSL color based on float encoding. + + \ingroup valuehsl + */ + /// \cond ALIASES typedef hsl_<float, float, float> hsl_f; + /// \endcond + + /*! + \class hsl_d + \headerfile <> + + \brief HSL color based on double encoding. + \ingroup valuehsl + */ + /// \cond ALIASES typedef hsl_<double, double, double> hsl_d; + /// \endcond /// Print an hsl \p c into the output stream \p ostr. @@ -233,6 +253,7 @@ namespace mln /// \} + /// \cond INTERNAL_API // Conversions /// \internal Conversion: hsl -> qt::rgb32. @@ -242,6 +263,7 @@ namespace mln /// \internal Conversion: hsl -> rgb8. template <typename H, typename S, typename L> void from_to_(const value::hsl_<H,S,L>&, value::rgb<8>& to); + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_s.hh b/milena/mln/value/int_s.hh index ca2e46f..2d8a1b1 100644 --- a/milena/mln/value/int_s.hh +++ b/milena/mln/value/int_s.hh @@ -107,9 +107,12 @@ namespace mln { - /*! \brief Signed integer value class. - * - * The parameter is \c n the number of encoding bits. + /*! + \brief Signed integer value class. + + The parameter is \c n the number of encoding bits. + + \ingroup valueint */ template <unsigned n> struct int_s diff --git a/milena/mln/value/int_s16.hh b/milena/mln/value/int_s16.hh index 188bcfa..df4bf1e 100644 --- a/milena/mln/value/int_s16.hh +++ b/milena/mln/value/int_s16.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,8 +42,18 @@ namespace mln { - /// Alias for signed 16-bit integers. + /*! + \struct int_s16 + \headerfile <> + + \brief Alias for signed 16-bit integers. + + \ingroup valueint + \relates int_s + */ + /// \cond ALIASES typedef int_s<16> int_s16; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_s24.hh b/milena/mln/value/int_s24.hh index e947b47..6cd10a6 100644 --- a/milena/mln/value/int_s24.hh +++ b/milena/mln/value/int_s24.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2012 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2012, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -38,8 +39,18 @@ namespace mln namespace value { - /// Alias for signed 24-bit integers. + /*! + \struct int_s24 + \headerfile <> + + \brief Alias for signed 24-bit integers. + + \ingroup valueint + \relates int_s + */ + /// \cond ALIASES typedef mln::value::int_s<24> int_s24; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_s32.hh b/milena/mln/value/int_s32.hh index 4303597..e21bb51 100644 --- a/milena/mln/value/int_s32.hh +++ b/milena/mln/value/int_s32.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,8 +42,18 @@ namespace mln { - /// Alias for signed 32-bit integers. + /*! + \struct int_s32 + \headerfile <> + + \brief Alias for signed 32-bit integers. + + \ingroup valueint + \relates int_s + */ + /// \cond ALIASES typedef int_s<32> int_s32; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_s8.hh b/milena/mln/value/int_s8.hh index f44c0c9..1277980 100644 --- a/milena/mln/value/int_s8.hh +++ b/milena/mln/value/int_s8.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,8 +42,19 @@ namespace mln { - /// Alias for signed 8-bit integers. + /*! + \struct int_s8 + \headerfile <> + + \brief Alias for signed 8-bit integers. + + \ingroup valueint + \relates int_s + */ + /// \cond ALIASES typedef int_s<8> int_s8; + /// \endcond + } // end of namespace mln::value diff --git a/milena/mln/value/int_u.hh b/milena/mln/value/int_u.hh index d051c13..8e1e0ec 100644 --- a/milena/mln/value/int_u.hh +++ b/milena/mln/value/int_u.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2010, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -113,9 +113,13 @@ namespace mln namespace value { - /// Unsigned integer value class. - /// - /// The parameter is \c n the number of encoding bits. + /*! + \brief Unsigned integer value class. + + The parameter is \c n the number of encoding bits. + + \ingroup valueuint + */ template <unsigned n> struct int_u : diff --git a/milena/mln/value/int_u12.hh b/milena/mln/value/int_u12.hh index 295713c..b8d60c0 100644 --- a/milena/mln/value/int_u12.hh +++ b/milena/mln/value/int_u12.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2009, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -41,8 +42,18 @@ namespace mln { - /// Alias for unsigned 12-bit integers. + /*! + \struct int_u12 + \headerfile <> + + \brief Alias for unsigned 12-bit integers. + + \ingroup valueuint + \relates value::int_u + */ + /// \cond ALIASES typedef int_u<12> int_u12; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_u16.hh b/milena/mln/value/int_u16.hh index 24b0727..39db82e 100644 --- a/milena/mln/value/int_u16.hh +++ b/milena/mln/value/int_u16.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,8 +42,18 @@ namespace mln { - /// Alias for unsigned 16-bit integers. + /*! + \struct int_u16 + \headerfile <> + + \brief Alias for unsigned 16-bit integers. + + \ingroup valueuint + \relates value::int_u + */ + /// \cond ALIASES typedef int_u<16> int_u16; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_u24.hh b/milena/mln/value/int_u24.hh index 1a4935d..5d72a92 100644 --- a/milena/mln/value/int_u24.hh +++ b/milena/mln/value/int_u24.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2012 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2012, 2013 EPITA Research and Development Laboratory +// (LRDE) // // This file is part of Olena. // @@ -38,8 +39,18 @@ namespace mln namespace value { - /// Alias for unsigned 24-bit integers. + /*! + \struct int_u24 + \headerfile <> + + \brief Alias for unsigned 24-bit integers. + + \ingroup valueuint + \relates value::int_u + */ + /// \cond ALIASES typedef mln::value::int_u<24> int_u24; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_u32.hh b/milena/mln/value/int_u32.hh index d5c46b2..7d51cc9 100644 --- a/milena/mln/value/int_u32.hh +++ b/milena/mln/value/int_u32.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,8 +42,18 @@ namespace mln { - /// Alias for unsigned 32-bit integers. + /*! + \struct int_u32 + \headerfile <> + + \brief Alias for unsigned 32-bit integers. + + \ingroup valueuint + \relates value::int_u + */ + /// \cond ALIASES typedef mln::value::int_u<32> int_u32; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/int_u8.hh b/milena/mln/value/int_u8.hh index 5260f42..bfd9770 100644 --- a/milena/mln/value/int_u8.hh +++ b/milena/mln/value/int_u8.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,8 +41,18 @@ namespace mln { - /// Alias for unsigned 8-bit integers. + /*! + \struct int_u8 + \headerfile <> + + \brief Alias for unsigned 8-bit integers. + + \ingroup valueuint + \relates value::int_u + */ + /// \cond ALIASES typedef mln::value::int_u<8> int_u8; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/label.hh b/milena/mln/value/label.hh index dd0f924..b43a927 100644 --- a/milena/mln/value/label.hh +++ b/milena/mln/value/label.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and -// Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 EPITA +// Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -95,10 +95,13 @@ namespace mln { - /// Label value class. - /// - /// The parameter \c n is the number of encoding bits. - /// + /*! + \brief Label value class. + + The parameter \c n is the number of encoding bits. + + \ingroup valuelabel + */ template <unsigned n> struct label : public Symbolic< label<n> >, diff --git a/milena/mln/value/label_16.hh b/milena/mln/value/label_16.hh index a782dd0..a9a42dc 100644 --- a/milena/mln/value/label_16.hh +++ b/milena/mln/value/label_16.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,8 +41,18 @@ namespace mln { - /// Alias for 16-bit integers. + /*! + \struct label_16 + \headerfile <> + + \brief Alias for 16-bit integers. + + \ingroup valuelabel + \relates value::label + */ + /// \cond ALIASES typedef label<16> label_16; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/label_32.hh b/milena/mln/value/label_32.hh index a4603e1..a2c69e4 100644 --- a/milena/mln/value/label_32.hh +++ b/milena/mln/value/label_32.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,7 +41,11 @@ namespace mln { - /// Alias for 32-bit integers. + /*! + \brief Alias for 32-bit integers. + \ingroup valuelabel + \relates value::label + */ typedef label<32> label_32; diff --git a/milena/mln/value/label_8.hh b/milena/mln/value/label_8.hh index e72ab8c..fe736e5 100644 --- a/milena/mln/value/label_8.hh +++ b/milena/mln/value/label_8.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,8 +41,18 @@ namespace mln { - /// Alias for 8-bit labels. + /*! + \struct label_8 + \headerfile <> + + \brief Alias for 8-bit labels. + + \ingroup valuelabel + \relates value::label + */ + /// \cond ALIASES typedef mln::value::label<8> label_8; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/qt/rgb32.hh b/milena/mln/value/qt/rgb32.hh index 67bf1eb..96404b8 100644 --- a/milena/mln/value/qt/rgb32.hh +++ b/milena/mln/value/qt/rgb32.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2010, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2010, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -164,9 +164,16 @@ namespace mln namespace qt { - /// Color class for red-green-blue where every component is - /// n-bit encoded. + /*! + \brief Color class for red-green-blue where every component is + 8-bit encoded. + This class allows the conversion from a mln::image2d to a QImage encoded with + QImage::Format_RGB32 or QImage::Format_ARGB32. + + \ingroup valuergb + \sa to_qimage_nocopy_qt_rgb32 + */ struct rgb32 : public Vectorial< rgb32 >, diff --git a/milena/mln/value/rgb.hh b/milena/mln/value/rgb.hh index 1c812d7..b29b479 100644 --- a/milena/mln/value/rgb.hh +++ b/milena/mln/value/rgb.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2010, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -195,8 +195,12 @@ namespace mln namespace value { - /// Color class for red-green-blue where every component is - /// n-bit encoded. + /*! + \brief Color class for red-green-blue where every component is + n-bit encoded. + + \ingroup valuergb + */ template <unsigned n> struct rgb : diff --git a/milena/mln/value/rgb16.hh b/milena/mln/value/rgb16.hh index 6bb780d..b3803e6 100644 --- a/milena/mln/value/rgb16.hh +++ b/milena/mln/value/rgb16.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,9 +41,19 @@ namespace mln namespace value { - /// Color class for red-green-blue where every component is - /// 16-bit encoded. + /*! + \struct rgb16 + \headerfile <> + + \brief Color class for red-green-blue where every component is + 16-bit encoded. + + \ingroup valuergb + \relates value::rgb + */ + /// \cond ALIASES typedef rgb<16> rgb16; + /// \endcond } // end of namespace mln::value diff --git a/milena/mln/value/rgb8.hh b/milena/mln/value/rgb8.hh index 272eeb2..b6e7940 100644 --- a/milena/mln/value/rgb8.hh +++ b/milena/mln/value/rgb8.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -40,9 +41,19 @@ namespace mln namespace value { - /// Color class for red-green-blue where every component is - /// 8-bit encoded. + /*! + \struct rgb8 + \headerfile <> + + \brief Color class for red-green-blue where every component is + 8-bit encoded. + + \ingroup valuergb + \relates value::rgb + */ + /// \cond ALIASES typedef rgb<8> rgb8; + /// \endcond } // end of namespace mln::value -- 1.7.2.5

1 0

olena-2.0-472-g26b7669 Add a PDF I/O group in documentation.
by Guillaume Lazzara 11 Apr '13

11 Apr '13

* doc/mln/io/io.dox: Add PDF group. * mln/io/pdf/get_header.hh, * mln/io/pdf/load.hh: Add to PDF group. --- milena/ChangeLog | 9 +++++++++ milena/doc/mln/io/io.dox | 7 +++++++ milena/mln/io/pdf/get_header.hh | 10 ++++++++-- milena/mln/io/pdf/load.hh | 12 ++++++++++++ 4 files changed, 36 insertions(+), 2 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index d3014e9..fa1c5b8 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,14 @@ 2013-04-11 Guillaume Lazzara <z(a)lrde.epita.fr> + Add a PDF I/O group in documentation. + + * doc/mln/io/io.dox: Add PDF group. + + * mln/io/pdf/get_header.hh, + * mln/io/pdf/load.hh: Add to PDF group. + +2013-04-11 Guillaume Lazzara <z(a)lrde.epita.fr> + Add references to code examples * doc/DoxygenLayout.xml: Change example section name. diff --git a/milena/doc/mln/io/io.dox b/milena/doc/mln/io/io.dox index cc2ae0d..97c199e 100644 --- a/milena/doc/mln/io/io.dox +++ b/milena/doc/mln/io/io.dox @@ -108,3 +108,10 @@ * * \ingroup iogroup */ + +/*! \defgroup iopdf PDF + * + * \brief PDF I/O routines. + * + * \ingroup iogroup + */ diff --git a/milena/mln/io/pdf/get_header.hh b/milena/mln/io/pdf/get_header.hh index 946dbfd..9a2e164 100644 --- a/milena/mln/io/pdf/get_header.hh +++ b/milena/mln/io/pdf/get_header.hh @@ -51,7 +51,10 @@ namespace mln namespace pdf { - /// Store pdf file header. + /*! + \brief Store pdf file header. + \ingroup iopdf + */ struct pdf_header { pdf_header(const poppler::document *doc); @@ -66,7 +69,10 @@ namespace mln }; - /// Retrieve header in a pdf file. + /*! + \brief Retrieve header in a pdf file. + \ingroup iopdf + */ pdf_header get_header(const std::string& filename); diff --git a/milena/mln/io/pdf/load.hh b/milena/mln/io/pdf/load.hh index 59b0736..84e0926 100644 --- a/milena/mln/io/pdf/load.hh +++ b/milena/mln/io/pdf/load.hh @@ -52,6 +52,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array& arr, const std::string& filename, @@ -69,6 +71,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array& arr, const std::string& filename, @@ -86,6 +90,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array& arr, const std::string& filename, @@ -102,6 +108,8 @@ namespace mln \param[in] dpi Document resolution. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(Image& ima, const std::string& filename, @@ -117,6 +125,8 @@ namespace mln DPI resolution is set to 300. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array& arr, const std::string& filename); @@ -132,6 +142,8 @@ namespace mln DPI resolution is set to 300. Page numbering starts from 0. + + \ingroup iopdf */ template <typename I> void load(util::array& arr, const std::string& filename, -- 1.7.2.5

1 0

olena-2.0-471-gaf99848 Add references to code examples
by Guillaume Lazzara 11 Apr '13

11 Apr '13

* doc/DoxygenLayout.xml: Change example section name. * doc/examples.dox: Add more links to example files. --- milena/ChangeLog | 8 ++++++++ milena/doc/DoxygenLayout.xml | 2 +- milena/doc/examples.dox | 11 +++++++++-- 3 files changed, 18 insertions(+), 3 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 890523f..d3014e9 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,13 @@ 2013-04-11 Guillaume Lazzara <z(a)lrde.epita.fr> + Add references to code examples + + * doc/DoxygenLayout.xml: Change example section name. + + * doc/examples.dox: Add more links to example files. + +2013-04-11 Guillaume Lazzara <z(a)lrde.epita.fr> + Hide internal API and classes in documentation. * doc/Doxyfile.in: Exclude internal symbols and classes. diff --git a/milena/doc/DoxygenLayout.xml b/milena/doc/DoxygenLayout.xml index ae704ea..cc73c43 100644 --- a/milena/doc/DoxygenLayout.xml +++ b/milena/doc/DoxygenLayout.xml @@ -20,7 +20,7 @@ <tab type="filelist" visible="yes" title="" intro=""/> <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="examples" visible="yes" title="Examples" intro=""/> + <tab type="examples" visible="yes" title="Full Examples" intro=""/> <tab type="user" url="@ref examples" title="Examples"/> <tab type="user" url="http://caroussel.lrde.epita.fr/olena/demos" title="Demos"/> <tab type="user" url="http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/Publications" title="Publications"/> diff --git a/milena/doc/examples.dox b/milena/doc/examples.dox index ef6845e..ab18c38 100644 --- a/milena/doc/examples.dox +++ b/milena/doc/examples.dox @@ -1,7 +1,14 @@ /*! \page examples Examples -\section examplerag Region Adjacency Graph +\section examplesgenericity Genericity -\li \link region_adjacency_graph.cc +\li \link demos/genericity/neighborhood/neighborhood.cc Classical neighborhoods \endlink +\li \link demos/genericity/neighborhood/duality.cc Dual neighborhoods \endlink +\li \link demos/genericity/neighborhood/permissive.cc Custom neighborhoods \endlink +\li \link demos/inter_pixel/inter_pixel.cc Inter-pixel processings \endlink + + +\section examplesgraph Graphs +\li \link demos/graph/region_adjacency_graph.cc Region Adjacency Graph \endlink */ -- 1.7.2.5

1 0

olena-2.0-470-ga35bff3 Hide internal API and classes in documentation.
by Guillaume Lazzara 11 Apr '13

11 Apr '13

* doc/Doxyfile.in: Exclude internal symbols and classes. * mln/core/alias/vec2d.hh, * mln/core/alias/vec3d.hh, * mln/core/box_runend_piter.hh, * mln/core/box_runstart_piter.hh, * mln/core/dpoints_pixter.hh, * mln/core/dpsites_piter.hh, * mln/core/faces_psite.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/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/classical_window_base.hh, * mln/core/internal/graph_psite_base.hh, * mln/core/internal/image_base.hh, * mln/core/internal/image_identity.hh, * mln/core/internal/image_morpher.hh, * mln/core/internal/labeled_image_base.hh, * mln/core/internal/neighb_base.hh, * mln/core/internal/neighb_niter_base.hh, * mln/core/internal/p_complex_piter_base.hh, * mln/core/internal/piter_adaptor.hh, * mln/core/internal/pseudo_site_base.hh, * mln/core/internal/run_image.hh, * mln/core/internal/set_of.hh, * mln/core/internal/site_iterator_base.hh, * mln/core/internal/site_relative_iterator_base.hh, * mln/core/internal/site_set_base.hh, * mln/core/internal/site_set_impl.hh, * mln/core/internal/site_set_iterator_base.hh, * mln/core/internal/window_base.hh, * mln/core/mixed_neighb.hh, * mln/core/neighb.hh, * mln/core/pixter1d.hh, * mln/core/pixter2d.hh, * mln/core/pixter3d.hh, * mln/core/point.hh, * mln/core/routine/init.hh, * mln/core/site_set/box.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_centered.hh, * mln/core/site_set/p_complex_piter.hh, * mln/core/site_set/p_double.hh, * mln/core/site_set/p_edges_psite.hh, * mln/core/site_set/p_faces.hh, * mln/core/site_set/p_graph_piter.hh, * mln/core/site_set/p_if.hh, * mln/core/site_set/p_if_piter.hh, * mln/core/site_set/p_image.hh, * mln/core/site_set/p_key.hh, * mln/core/site_set/p_line2d.hh, * mln/core/site_set/p_mutable_array_of.hh, * mln/core/site_set/p_priority.hh, * mln/core/site_set/p_run.hh, * mln/core/site_set/p_run_piter.hh, * mln/core/site_set/p_set_of.hh, * mln/core/site_set/p_transformed.hh, * mln/core/site_set/p_transformed_piter.hh, * mln/core/site_set/p_vaccess.hh, * mln/core/site_set/p_vertices_psite.hh, * mln/core/w_window.hh, * mln/core/window.hh, * mln/util/array.hh: Prevent internal API from appearing in user documentation. --- milena/ChangeLog | 105 ++++++++++++++++++++ milena/doc/Doxyfile.in | 51 ++++++++-- milena/mln/core/alias/vec2d.hh | 2 +- milena/mln/core/alias/vec3d.hh | 2 +- milena/mln/core/box_runend_piter.hh | 11 ++- milena/mln/core/box_runstart_piter.hh | 8 ++ milena/mln/core/dpoints_pixter.hh | 16 +++- milena/mln/core/dpsites_piter.hh | 14 +++- milena/mln/core/faces_psite.hh | 7 +- milena/mln/core/image/ch_piter.hh | 6 +- milena/mln/core/image/complex_image.hh | 8 +- .../mln/core/image/complex_neighborhood_piter.hh | 6 +- milena/mln/core/image/complex_window_piter.hh | 6 +- milena/mln/core/image/dmorph/extended.hh | 10 +- milena/mln/core/image/dmorph/extension_fun.hh | 11 ++- milena/mln/core/image/dmorph/extension_ima.hh | 10 ++- milena/mln/core/image/dmorph/extension_val.hh | 9 ++- milena/mln/core/image/dmorph/hexa.hh | 9 +- milena/mln/core/image/dmorph/hexa_piter.hh | 7 +- milena/mln/core/image/dmorph/image_if.hh | 7 +- milena/mln/core/image/dmorph/p2p_image.hh | 5 +- milena/mln/core/image/dmorph/slice_image.hh | 7 +- milena/mln/core/image/dmorph/sub_image.hh | 11 +- milena/mln/core/image/dmorph/sub_image_if.hh | 8 +- milena/mln/core/image/dmorph/transformed_image.hh | 5 +- milena/mln/core/image/dmorph/unproject_image.hh | 7 +- milena/mln/core/image/edge_image.hh | 9 +- milena/mln/core/image/flat_image.hh | 12 ++- milena/mln/core/image/graph_window_if_piter.hh | 13 ++- milena/mln/core/image/graph_window_piter.hh | 10 +- milena/mln/core/image/image1d.hh | 10 ++- milena/mln/core/image/image2d.hh | 26 ++--- milena/mln/core/image/image3d.hh | 14 ++- milena/mln/core/image/imorph/decorated_image.hh | 9 +- milena/mln/core/image/imorph/interpolated.hh | 7 +- milena/mln/core/image/imorph/labeled_image.hh | 11 ++- milena/mln/core/image/imorph/lazy_image.hh | 5 +- milena/mln/core/image/imorph/plain.hh | 5 +- milena/mln/core/image/imorph/safe.hh | 5 +- milena/mln/core/image/imorph/tr_image.hh | 5 +- milena/mln/core/image/vertex_image.hh | 7 +- milena/mln/core/image/vmorph/cast_image.hh | 7 +- milena/mln/core/image/vmorph/fun_image.hh | 5 +- milena/mln/core/image/vmorph/thru_image.hh | 7 +- milena/mln/core/image/vmorph/violent_cast_image.hh | 5 +- milena/mln/core/internal/classical_window_base.hh | 5 +- milena/mln/core/internal/graph_psite_base.hh | 5 +- milena/mln/core/internal/image_base.hh | 15 ++- milena/mln/core/internal/image_identity.hh | 5 +- milena/mln/core/internal/image_morpher.hh | 13 ++- milena/mln/core/internal/labeled_image_base.hh | 4 +- milena/mln/core/internal/neighb_base.hh | 8 +- milena/mln/core/internal/neighb_niter_base.hh | 8 +- milena/mln/core/internal/p_complex_piter_base.hh | 5 +- milena/mln/core/internal/piter_adaptor.hh | 13 ++- milena/mln/core/internal/pseudo_site_base.hh | 3 +- milena/mln/core/internal/run_image.hh | 5 +- milena/mln/core/internal/set_of.hh | 5 +- milena/mln/core/internal/site_iterator_base.hh | 7 +- .../core/internal/site_relative_iterator_base.hh | 9 +- milena/mln/core/internal/site_set_base.hh | 5 +- milena/mln/core/internal/site_set_impl.hh | 3 +- milena/mln/core/internal/site_set_iterator_base.hh | 12 ++- milena/mln/core/internal/window_base.hh | 12 ++- milena/mln/core/mixed_neighb.hh | 11 +- milena/mln/core/neighb.hh | 10 +- milena/mln/core/pixter1d.hh | 8 +- milena/mln/core/pixter2d.hh | 12 ++- milena/mln/core/pixter3d.hh | 10 +- milena/mln/core/point.hh | 12 ++- milena/mln/core/routine/init.hh | 3 +- milena/mln/core/site_set/box.hh | 3 +- milena/mln/core/site_set/box_piter.hh | 10 +- milena/mln/core/site_set/complex_psite.hh | 14 ++- milena/mln/core/site_set/p_array.hh | 25 ++++- milena/mln/core/site_set/p_centered.hh | 6 +- milena/mln/core/site_set/p_complex_piter.hh | 6 +- milena/mln/core/site_set/p_double.hh | 15 ++- milena/mln/core/site_set/p_edges_psite.hh | 6 +- milena/mln/core/site_set/p_faces.hh | 4 +- milena/mln/core/site_set/p_graph_piter.hh | 9 +- milena/mln/core/site_set/p_if.hh | 5 +- milena/mln/core/site_set/p_if_piter.hh | 7 +- milena/mln/core/site_set/p_image.hh | 11 ++- milena/mln/core/site_set/p_key.hh | 10 ++- milena/mln/core/site_set/p_line2d.hh | 3 +- milena/mln/core/site_set/p_mutable_array_of.hh | 10 ++- milena/mln/core/site_set/p_priority.hh | 8 +- milena/mln/core/site_set/p_run.hh | 7 +- milena/mln/core/site_set/p_run_piter.hh | 10 +- milena/mln/core/site_set/p_set_of.hh | 7 +- milena/mln/core/site_set/p_transformed.hh | 6 +- milena/mln/core/site_set/p_transformed_piter.hh | 7 +- milena/mln/core/site_set/p_vaccess.hh | 6 +- milena/mln/core/site_set/p_vertices_psite.hh | 6 +- milena/mln/core/w_window.hh | 11 +- milena/mln/core/window.hh | 8 +- milena/mln/util/array.hh | 20 ++-- 98 files changed, 673 insertions(+), 295 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index efb3e12..890523f 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,108 @@ +2013-04-11 Guillaume Lazzara <z(a)lrde.epita.fr> + + Hide internal API and classes in documentation. + + * doc/Doxyfile.in: Exclude internal symbols and classes. + + * mln/core/alias/vec2d.hh, + * mln/core/alias/vec3d.hh, + * mln/core/box_runend_piter.hh, + * mln/core/box_runstart_piter.hh, + * mln/core/dpoints_pixter.hh, + * mln/core/dpsites_piter.hh, + * mln/core/faces_psite.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/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/classical_window_base.hh, + * mln/core/internal/graph_psite_base.hh, + * mln/core/internal/image_base.hh, + * mln/core/internal/image_identity.hh, + * mln/core/internal/image_morpher.hh, + * mln/core/internal/labeled_image_base.hh, + * mln/core/internal/neighb_base.hh, + * mln/core/internal/neighb_niter_base.hh, + * mln/core/internal/p_complex_piter_base.hh, + * mln/core/internal/piter_adaptor.hh, + * mln/core/internal/pseudo_site_base.hh, + * mln/core/internal/run_image.hh, + * mln/core/internal/set_of.hh, + * mln/core/internal/site_iterator_base.hh, + * mln/core/internal/site_relative_iterator_base.hh, + * mln/core/internal/site_set_base.hh, + * mln/core/internal/site_set_impl.hh, + * mln/core/internal/site_set_iterator_base.hh, + * mln/core/internal/window_base.hh, + * mln/core/mixed_neighb.hh, + * mln/core/neighb.hh, + * mln/core/pixter1d.hh, + * mln/core/pixter2d.hh, + * mln/core/pixter3d.hh, + * mln/core/point.hh, + * mln/core/routine/init.hh, + * mln/core/site_set/box.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_centered.hh, + * mln/core/site_set/p_complex_piter.hh, + * mln/core/site_set/p_double.hh, + * mln/core/site_set/p_edges_psite.hh, + * mln/core/site_set/p_faces.hh, + * mln/core/site_set/p_graph_piter.hh, + * mln/core/site_set/p_if.hh, + * mln/core/site_set/p_if_piter.hh, + * mln/core/site_set/p_image.hh, + * mln/core/site_set/p_key.hh, + * mln/core/site_set/p_line2d.hh, + * mln/core/site_set/p_mutable_array_of.hh, + * mln/core/site_set/p_priority.hh, + * mln/core/site_set/p_run.hh, + * mln/core/site_set/p_run_piter.hh, + * mln/core/site_set/p_set_of.hh, + * mln/core/site_set/p_transformed.hh, + * mln/core/site_set/p_transformed_piter.hh, + * mln/core/site_set/p_vaccess.hh, + * mln/core/site_set/p_vertices_psite.hh, + * mln/core/w_window.hh, + * mln/core/window.hh, + * mln/util/array.hh: Prevent internal API from appearing in user + documentation. + + 2013-04-10 Guillaume Lazzara <z(a)lrde.epita.fr> * doc/Makefile.am: Fix permissions on documentation files. diff --git a/milena/doc/Doxyfile.in b/milena/doc/Doxyfile.in index 302b669..5727c5d 100644 --- a/milena/doc/Doxyfile.in +++ b/milena/doc/Doxyfile.in @@ -81,7 +81,7 @@ OUTPUT_LANGUAGE = English # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. -BRIEF_MEMBER_DESC = YES +BRIEF_MEMBER_DESC = NO # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. @@ -365,7 +365,7 @@ LOOKUP_CACHE_SIZE = 0 # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. @@ -416,7 +416,7 @@ HIDE_UNDOC_MEMBERS = NO # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. -HIDE_UNDOC_CLASSES = YES +HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. @@ -732,7 +732,43 @@ EXCLUDE_PATTERNS = *spe.hh # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = mln::*_check* \ + mln::internal::check::* \ + mln::internal::data<* \ + mln::internal::subject_impl<* \ + mln::internal::subject_impl \ + mln::internal::subject_point_impl<* \ + mln::internal::subject_point_impl \ + mln::trait::accumulator_<* \ + mln::trait::image_<* \ + mln::trait::op_*< \ + mln::trait::impl::ch_value_<* \ + mln::trait::site_set_<* \ + mln::trait::set_* \ + mln::trait::value_* \ + mln::trait::window_<* \ + mln::trait::internal::merge_triplet_<* \ + mln::trait::next::set_binary_<* \ + mln::trait::next::set_unary_<* \ + mln::trait::next::helper_get_unary_<* \ + mln::trait::next::helper_get_binary_<* \ + mln::trait::next::helper_solve_binary_<* \ + mln::trait::next::helper_solver_unary_<* \ + mln::trait::next::internal::helper_get_unary_<* \ + mln::trait::next::internal::helper_get_binary_<* \ + mln::trait::next::internal::set_unary_<* \ + mln::trait::next::internal::set_binary_<* \ + mln::trait::next::internal::helper_solve_binary_<* \ + mln::trait::next::internal::helper_solver_unary_<* \ + mln::metal::* \ + mln::trait::* \ + mln::doc::* \ + mln::io::*::internal::* \ + mln::internal::exact_* \ + mln::internal::fixme \ + mln::internal::helper*category* \ + mln::tag::* + # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see @@ -828,13 +864,13 @@ STRIP_CODE_COMMENTS = YES # then for each documented function all documented # functions referencing it will be listed. -REFERENCED_BY_RELATION = YES +REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. -REFERENCES_RELATION = YES +REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from @@ -1548,7 +1584,8 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ +PREDEFINED = MLN_INCLUDE_ONLY \ + "for_all(x)=for(x.start(); x.is_valid(); x.next())" \ "for_all_2(x1, x2)=for(x1.start(), x2.start(); x1.is_valid(); x1.next(), x2.next())" \ "for_all_3(x1, x2, x3)=for(x1.start(), x2.start(), x3.start(); x1.is_valid(); x1.next(), x2.next(), x3.next())" \ "for_all_remaining(x)=if (! x.is_valid()) {} else while (x.next(), x.is_valid())" \ diff --git a/milena/mln/core/alias/vec2d.hh b/milena/mln/core/alias/vec2d.hh index 4a27abf..5affec9 100644 --- a/milena/mln/core/alias/vec2d.hh +++ b/milena/mln/core/alias/vec2d.hh @@ -51,7 +51,7 @@ namespace mln /*! - \class vec2d_f + \class vec2d_d \headerfile <> \brief 2D vector with double coordinates. diff --git a/milena/mln/core/alias/vec3d.hh b/milena/mln/core/alias/vec3d.hh index 4e09d17..2e9c8d5 100644 --- a/milena/mln/core/alias/vec3d.hh +++ b/milena/mln/core/alias/vec3d.hh @@ -50,7 +50,7 @@ namespace mln /// \endcond /*! - \class vec3d_f + \class vec3d_d \headerfile <> \brief 3D vector with double coordinates. diff --git a/milena/mln/core/box_runend_piter.hh b/milena/mln/core/box_runend_piter.hh index fdb886f..dc5b3b5 100644 --- a/milena/mln/core/box_runend_piter.hh +++ b/milena/mln/core/box_runend_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -66,11 +66,15 @@ namespace mln */ box_runend_piter(const box& b); + /// \cond INTERNAL_API /// Delayed initialization. void init_(const box& b); + /// \endcond box_runend_piter(); + /// \cond INTERNAL_API + /// Test the iterator validity. bool is_valid_() const; @@ -83,6 +87,9 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond + + /// Give the lenght of the run unsigned run_length() const; diff --git a/milena/mln/core/box_runstart_piter.hh b/milena/mln/core/box_runstart_piter.hh index dec4a42..aaff6d5 100644 --- a/milena/mln/core/box_runstart_piter.hh +++ b/milena/mln/core/box_runstart_piter.hh @@ -66,11 +66,16 @@ namespace mln */ box_runstart_piter(const box& b); + /// \cond INTERNAL_API /// Delayed initialization. void init_(const box& b); + /// \endcond box_runstart_piter(); + + /// \cond INTERNAL_API + /// Test the iterator validity. bool is_valid_() const; @@ -83,6 +88,9 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond + + /// Give the lenght of the run unsigned run_length() const; diff --git a/milena/mln/core/dpoints_pixter.hh b/milena/mln/core/dpoints_pixter.hh index 2a79e12..6189152 100644 --- a/milena/mln/core/dpoints_pixter.hh +++ b/milena/mln/core/dpoints_pixter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -90,8 +90,11 @@ namespace mln /// \{ /// Start an iteration. void start(); + + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); + /// \endcond /// Invalidate the iterator. void invalidate(); @@ -106,6 +109,7 @@ namespace mln /// The value around which this iterator moves. const mln_value(I)& center_val() const; + /// \cond INTERNAL_API private: template <typename Dps> void init_(const Dps& dps); @@ -129,6 +133,9 @@ namespace mln /// Reference pixel / point in the image const mln_psite(I)* p_ref_; /// \} + + /// \endcond + }; @@ -176,8 +183,11 @@ namespace mln /// \{ /// Start an iteration. void start(); + + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); + /// \endcond /// Invalidate the iterator. void invalidate(); @@ -192,6 +202,8 @@ namespace mln /// The value around which this iterator moves. const mln_value(I)& center_val() const; + /// \cond INTERNAL_API + private: template <typename Dps> void init_(const Dps& dps); @@ -215,6 +227,8 @@ namespace mln /// Reference pixel / point in the image const mln_psite(I)* p_ref_; /// \} + + /// \endcond }; diff --git a/milena/mln/core/dpsites_piter.hh b/milena/mln/core/dpsites_piter.hh index 927ac6b..838f856 100644 --- a/milena/mln/core/dpsites_piter.hh +++ b/milena/mln/core/dpsites_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -60,13 +60,17 @@ namespace mln template <typename P> dpsites_fwd_piter(const V& v, const P& c); + /// \cond INTERNAL_API + /// Delayed initialization. template <typename P> void init_(const V& v, const P& c); + /// \endcond /// Constructor without argument. dpsites_fwd_piter(); + /// \cond INTERNAL_API /// Test the iterator validity. bool is_valid_() const; @@ -85,6 +89,8 @@ namespace mln protected: unsigned i_; + + /// \endcond }; @@ -112,6 +118,8 @@ namespace mln /// Constructor without argument. dpsites_bkd_piter(); + /// \cond INTERNAL_API + /// Delayed initialization. template <typename P> void init_(const V& v, const P& c); @@ -134,6 +142,8 @@ namespace mln protected: int i_; + + /// \endcond }; diff --git a/milena/mln/core/faces_psite.hh b/milena/mln/core/faces_psite.hh index 9f72533..de3ee78 100644 --- a/milena/mln/core/faces_psite.hh +++ b/milena/mln/core/faces_psite.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -86,16 +86,21 @@ namespace mln /// \pre Member face_ is valid. const target& site_set() const; + /// \cond INTERNAL_API /// Get a pointer to the target site_set. const target* target_() const; + /// \endcond + /// Set the target site_set. void change_target(const target& new_target); /// \} /// Proxy manipulators. /// \{ + /// \cond INTERNAL_API /// Return the site corresponding to this psite. const P& subj_(); + /// \endcond /// \} /// Face handle manipulators. diff --git a/milena/mln/core/image/ch_piter.hh b/milena/mln/core/image/ch_piter.hh index 2677edd..e12f7ff 100644 --- a/milena/mln/core/image/ch_piter.hh +++ b/milena/mln/core/image/ch_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -94,8 +94,10 @@ namespace mln ch_piter_image(); ch_piter_image(I& ima); + /// \cond INTERNAL_API // Deferred initialization. void init_(I& ima); + /// \endcond }; diff --git a/milena/mln/core/image/complex_image.hh b/milena/mln/core/image/complex_image.hh index d6b7480..b195dc5 100644 --- a/milena/mln/core/image/complex_image.hh +++ b/milena/mln/core/image/complex_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -99,7 +99,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::complex_image. */ template <unsigned D, typename G, typename V> @@ -198,9 +197,11 @@ namespace mln const metal::vec< D + 1, std::vector<V> >& values); /// \} + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const p_complex<D, G>& pc, const metal::vec< D + 1, std::vector<V> >& values); + /// \endcond /// Read-only access of face value at point site \p p. rvalue operator()(const complex_psite<D, G>& p) const; @@ -217,12 +218,13 @@ namespace mln /// \} }; + /// \cond INTERNAL_API // Fwd decl. template <unsigned D, typename G, typename V, typename W> void init_(tag::image_t, complex_image<D, G, V>& target, const complex_image<D, G, W>& model); - + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/complex_neighborhood_piter.hh b/milena/mln/core/image/complex_neighborhood_piter.hh index 51c049a..c5cffb3 100644 --- a/milena/mln/core/image/complex_neighborhood_piter.hh +++ b/milena/mln/core/image/complex_neighborhood_piter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -76,6 +76,7 @@ namespace mln const Pref& p_ref); /// \} + /// \cond INTERNAL_API /// Delayed initialization. template <typename Pref> void init_(const Neighborhood<N>& nbh, const Pref& p_ref); @@ -99,6 +100,7 @@ namespace mln /// Compute the current psite. psite compute_p_() const; /// \} + /// \endcond /// \brief Accessors. /// \{ @@ -150,6 +152,7 @@ namespace mln const Pref& p_ref); /// \} + /// \cond INTERNAL_API /// Delayed initialization. template <typename Pref> void init_(const Neighborhood<N>& nbh, const Pref& p_ref); @@ -173,6 +176,7 @@ namespace mln /// Compute the current psite. psite compute_p_() const; /// \} + /// \endcond /// \brief Accessors. /// \{ diff --git a/milena/mln/core/image/complex_window_piter.hh b/milena/mln/core/image/complex_window_piter.hh index 208d4e6..2e2c610 100644 --- a/milena/mln/core/image/complex_window_piter.hh +++ b/milena/mln/core/image/complex_window_piter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2010, 2011, 2012 EPITA Research and +// Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -75,6 +75,7 @@ namespace mln complex_window_fwd_piter(const Window<W>& win, const Pref& p_ref); /// \} + /// \cond INTERNAL_API /// Delayed initialization. template <typename Pref> void init_(const Window<W>& win, const Pref& p_ref); @@ -98,6 +99,7 @@ namespace mln /// Compute the current psite. psite compute_p_() const; /// \} + /// \endcond /// \brief Accessors. /// \{ @@ -148,6 +150,7 @@ namespace mln complex_window_bkd_piter(const Window<W>& win, const Pref& p_ref); /// \} + /// \cond INTERNAL_API /// Delayed initialization. template <typename Pref> void init_(const Window<W>& win, const Pref& p_ref); @@ -171,6 +174,7 @@ namespace mln /// Compute the current psite. psite compute_p_() const; /// \} + /// \endcond /// \brief Accessors. /// \{ diff --git a/milena/mln/core/image/dmorph/extended.hh b/milena/mln/core/image/dmorph/extended.hh index ed94a04..0864b10 100644 --- a/milena/mln/core/image/dmorph/extended.hh +++ b/milena/mln/core/image/dmorph/extended.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -51,7 +51,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::extended. */ template <typename I> @@ -111,17 +110,20 @@ namespace mln /// Constructor. extended(I& ima, const box<mln_site(I)>& b); + /// \cond INTERNAL_API /// Initialization. void init_(I& ima, const box<mln_site(I)>& b); + /// \endcond /// Give the definition domain. const box<mln_site(I)>& domain() const; }; - + /// \cond INTERNAL_API template <typename I, typename J> void init_(tag::image_t, extended& target, const J& model); + /// \endcond template <typename I, typename B> diff --git a/milena/mln/core/image/dmorph/extension_fun.hh b/milena/mln/core/image/dmorph/extension_fun.hh index aa5274e..ee46d36 100644 --- a/milena/mln/core/image/dmorph/extension_fun.hh +++ b/milena/mln/core/image/dmorph/extension_fun.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -50,7 +50,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::extension_fun<I, F>. */ template <typename I, typename F> @@ -122,9 +121,11 @@ namespace mln /// Constructor from an image \p ima and a function \p fun. extension_fun(I& ima, const F& fun); + /// \cond INTERNAL_API /// Deferred initialization from an image \p ima and a function \p /// fun. void init_(I& ima, const F& fun); + /// \endcond /// Test if \p p is valid. It returns always true, assuming that @@ -146,6 +147,8 @@ namespace mln }; + /// \cond INTERNAL_API + // init_ template <typename I, typename F, typename J> @@ -154,7 +157,7 @@ namespace mln template <typename F, typename I> void init_(tag::extension_t, F& target, const extension_fun<I,F>& model); - + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/dmorph/extension_ima.hh b/milena/mln/core/image/dmorph/extension_ima.hh index d194b82..c0f7827 100644 --- a/milena/mln/core/image/dmorph/extension_ima.hh +++ b/milena/mln/core/image/dmorph/extension_ima.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -47,7 +47,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::extension_ima<I, J>. */ template <typename I, typename J> @@ -119,9 +118,11 @@ namespace mln /// Constructor from an image \p ima and a function \p ext. extension_ima(I& ima, const J& ext); + /// \cond INTERNAL_API /// Deferred initialization from an image \p ima and a function \p /// ext. void init_(I& ima, const J& ext); + /// \endcond /// Test if \p p is valid. @@ -142,6 +143,8 @@ namespace mln }; + /// \cond INTERNAL_API + // init_ template <typename I, typename J, typename M> @@ -150,6 +153,7 @@ namespace mln template <typename J, typename I> void init_(tag::extension_t, J& target, const extension_ima<I,J>& model); + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/dmorph/extension_val.hh b/milena/mln/core/image/dmorph/extension_val.hh index e5ecef7..9183d1d 100644 --- a/milena/mln/core/image/dmorph/extension_val.hh +++ b/milena/mln/core/image/dmorph/extension_val.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -120,9 +120,11 @@ namespace mln /// Constructor from an image \p ima and a value \p val. extension_val(I& ima, const mln_value(I)& val); + /// \cond INTERNAL_API /// Deferred initialization from an image \p ima and a value \p /// val. void init_(I& ima, const mln_value(I)& val); + /// \endcond /// Test if \p p is valid. It returns always true. @@ -146,6 +148,8 @@ namespace mln }; + /// \cond INTERNAL_API + // init_ template <typename I, typename J> @@ -154,6 +158,7 @@ namespace mln template <typename V, typename I> void init_(tag::extension_t, V& target, const extension_val& model); + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/dmorph/hexa.hh b/milena/mln/core/image/dmorph/hexa.hh index cd856bd..0aa8c32 100644 --- a/milena/mln/core/image/dmorph/hexa.hh +++ b/milena/mln/core/image/dmorph/hexa.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -49,7 +49,6 @@ namespace mln namespace internal { /*! - \internal \brief Data structure for \c mln::hexa. */ template <typename I> @@ -67,7 +66,6 @@ namespace mln namespace trait { /*! - \internal FIXME: use the right properties. */ template <typename I> @@ -153,8 +151,10 @@ namespace mln /// Constructor with an base image. hexa(I& ima); + /// \cond INTERNAL_API /// Initialization. void init_(I& ima); + /// \endcond /// Give the definition domain. const box2d_h& domain() const; @@ -169,8 +169,11 @@ namespace mln lvalue operator()(const point2d_h& p); }; + + /// \cond INTERNAL_API template <typename I, typename J> void init_(tag::image_t, hexa& target, const J& model); + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/dmorph/hexa_piter.hh b/milena/mln/core/image/dmorph/hexa_piter.hh index d4841cd..e5f2908 100644 --- a/milena/mln/core/image/dmorph/hexa_piter.hh +++ b/milena/mln/core/image/dmorph/hexa_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -41,7 +41,6 @@ namespace mln { /*! - \internal \brief A generic forward iterator on points of subsets. Parameter \c S is a point set type; parameter F is a function @@ -67,8 +66,10 @@ namespace mln /// Start an iteration. void start(); + /// \cond INTERNAL_API /// Go to the next point. void next_(); + /// \endcond operator point2d_h() const; private: diff --git a/milena/mln/core/image/dmorph/image_if.hh b/milena/mln/core/image/dmorph/image_if.hh index ed9a05a..afa6702 100644 --- a/milena/mln/core/image/dmorph/image_if.hh +++ b/milena/mln/core/image/dmorph/image_if.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::image_if<I,F>. */ template <typename I, typename F> @@ -107,7 +106,9 @@ namespace mln /// Constructor from an image \p ima and a predicate \p f. image_if(I& ima, const F& f); + /// \cond INTERNAL_API void init_(I& ima, const F& f); + /// \endcond /// Give the definition domain. const p_if<mln_domain(I), F>& domain() const; diff --git a/milena/mln/core/image/dmorph/p2p_image.hh b/milena/mln/core/image/dmorph/p2p_image.hh index 3b2c563..d3cdc23 100644 --- a/milena/mln/core/image/dmorph/p2p_image.hh +++ b/milena/mln/core/image/dmorph/p2p_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -47,7 +47,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::p2p_image<I,F>. */ template <typename I, typename F> @@ -104,7 +103,9 @@ namespace mln /// Constructor from an image \p ima and a predicate \p f. p2p_image(I& ima, const F& f); + /// \cond INTERNAL_API void init_(I& ima, const F& f); + /// \endcond /// Give the definition domain. const mln_domain(I)& domain() const; diff --git a/milena/mln/core/image/dmorph/slice_image.hh b/milena/mln/core/image/dmorph/slice_image.hh index c779858..09036c2 100644 --- a/milena/mln/core/image/dmorph/slice_image.hh +++ b/milena/mln/core/image/dmorph/slice_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -50,7 +50,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::slice_image. */ template <typename I> @@ -110,7 +109,9 @@ namespace mln /// Constructor from an image \p ima and a predicate \p f. slice_image(I& ima, def::coord sli); + /// \cond INTERNAL_API void init_(I& ima, def::coord sli); + /// \endcond template <typename V> void operator=(const image2d<V>& rhs); diff --git a/milena/mln/core/image/dmorph/sub_image.hh b/milena/mln/core/image/dmorph/sub_image.hh index bf42c75..15cf254 100644 --- a/milena/mln/core/image/dmorph/sub_image.hh +++ b/milena/mln/core/image/dmorph/sub_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and -// Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 EPITA +// Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -51,7 +51,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::sub_image<I,S>. */ template <typename I, typename S> @@ -116,8 +115,10 @@ namespace mln /// Constructor. sub_image(const I& ima, const S& pset); + /// \cond INTERNAL_API /// Initialization. void init_(const I& ima, const S& pset); + /// \endcond /// Give the definition domain. const S& domain() const; @@ -140,10 +141,10 @@ namespace mln operator|(Image& ima, const Site_Set<S>& pset); - + /// \cond INTERNAL_API template <typename I, typename S, typename J> void init_(tag::image_t, sub_image<I,S>& target, const J& model); - + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/dmorph/sub_image_if.hh b/milena/mln/core/image/dmorph/sub_image_if.hh index f4c9fe2..ceb9f6a 100644 --- a/milena/mln/core/image/dmorph/sub_image_if.hh +++ b/milena/mln/core/image/dmorph/sub_image_if.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -115,8 +115,10 @@ namespace mln /// Constructor. sub_image_if(I& ima, const S& s); + /// \cond INTERNAL_API /// Initialization. void init_(I& ima, const S& s); + /// \endcond /// Give the definition domain. const p_if< S, fun::p2b::has >& domain() const; @@ -139,8 +141,10 @@ namespace mln operator / (Image& ima, const Site_Set<S>& s); + /// \cond INTERNAL_API template <typename I, typename S, typename J> void init_(tag::image_t, sub_image_if<I,S>& target, const J& model); + /// \endcond diff --git a/milena/mln/core/image/dmorph/transformed_image.hh b/milena/mln/core/image/dmorph/transformed_image.hh index 2a7970b..d2bee12 100644 --- a/milena/mln/core/image/dmorph/transformed_image.hh +++ b/milena/mln/core/image/dmorph/transformed_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2009, 2011, 2012 EPITA Research and Development +// Copyright (C) 2009, 2011, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -50,7 +50,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::transformed_image<I,F>. */ template <typename I, typename F> @@ -109,8 +108,10 @@ namespace mln /// Constructor. transformed_image(I& ima, const F& f); + /// \cond INTERNAL_API /// Initialization. void init_(I& ima, const F& f); + /// \endcond /// Give the definition domain. diff --git a/milena/mln/core/image/dmorph/unproject_image.hh b/milena/mln/core/image/dmorph/unproject_image.hh index 1f6c078..1ef6aac 100644 --- a/milena/mln/core/image/dmorph/unproject_image.hh +++ b/milena/mln/core/image/dmorph/unproject_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::unproject_image<I,D,F>. */ template <typename I, typename D, typename F> @@ -113,7 +112,9 @@ namespace mln /// Constructor from an image \p ima, a domain \p dom, and a function \p f. unproject_image(I& ima, const D& dom, const F& f); + /// \cond INTERNAL_API void init_(I& ima, const D& dom, const F& f); + /// \endcond /// Give the definition domain. diff --git a/milena/mln/core/image/edge_image.hh b/milena/mln/core/image/edge_image.hh index 5be1ff0..9cadce5 100644 --- a/milena/mln/core/image/edge_image.hh +++ b/milena/mln/core/image/edge_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -67,7 +67,7 @@ namespace mln namespace internal { - /*! \internal + /*! \brief Data structure for mln::pw::internal::image */ template <typename P, typename V, typename G> @@ -196,8 +196,11 @@ namespace mln }; + + /// \cond INTERNAL_API template <typename P, typename V, typename G, typename J> void init_(tag::image_t, edge_image<P,V,G>& target, const Image<J>& model); + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/flat_image.hh b/milena/mln/core/image/flat_image.hh index 813f29c..cc0047b 100644 --- a/milena/mln/core/image/flat_image.hh +++ b/milena/mln/core/image/flat_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::flat_image<T,S>. */ template <typename T, typename S> @@ -128,8 +127,10 @@ namespace mln /// Constructor. flat_image(const T& val, const S& pset); + /// \cond INTERNAL_API /// Initialization. void init_(const T& val, const S& pset); + /// \endcond /// Give the definition domain. const S& domain() const; @@ -145,15 +146,18 @@ namespace mln T& operator()(const mln_psite(S)& p); + /// \cond INTERNAL_API /// Specific methods. const T& value_() const; T& value_(); + /// \endcond }; - + /// \cond INTERNAL_API template <typename T, typename S, typename J> void init_(tag::image_t, flat_image<T,S>& target, const J& model); + /// \endcond diff --git a/milena/mln/core/image/graph_window_if_piter.hh b/milena/mln/core/image/graph_window_if_piter.hh index 7a865e1..6aa9bbc 100644 --- a/milena/mln/core/image/graph_window_if_piter.hh +++ b/milena/mln/core/image/graph_window_if_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -45,7 +45,6 @@ namespace mln /*! - \internal \brief Forward iterator on line graph window. */ template <typename S, typename W, typename I> @@ -73,6 +72,7 @@ namespace mln const Pref& p_ref); /// \} + /// \cond INTERNAL_API /// Delayed initialization. template <typename Pref> void init_(const Window<W>& win, const Pref& p_ref); @@ -97,11 +97,12 @@ namespace mln template <typename I2> void center_at_(const p_graph_piter<S, I2>& c); - /// Return the graph element pointed by this iterator. - const mln_graph_element(S)& element() const; - /// Compute the current psite. mln_psite(W) compute_p_() const; + /// \endcond + + /// Return the graph element pointed by this iterator. + const mln_graph_element(S)& element() const; /// Return the graph element id. /// FIXME: we do not want to have this member since there is an diff --git a/milena/mln/core/image/graph_window_piter.hh b/milena/mln/core/image/graph_window_piter.hh index 744e0bb..ad83521 100644 --- a/milena/mln/core/image/graph_window_piter.hh +++ b/milena/mln/core/image/graph_window_piter.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -164,6 +164,7 @@ namespace mln const Pref& p_ref); /// \} + /// \cond INTERNAL_API /// Delayed initialization. /// \{ template <typename Pref> @@ -193,11 +194,12 @@ namespace mln template <typename S2, typename I2> void center_at_(const p_graph_piter<S2, I2>& c); - /// Return the graph element pointed by this iterator. - const graph_element& element() const; - /// Compute the current psite. mln_psite(W) compute_p_() const; + /// \endcond + + /// Return the graph element pointed by this iterator. + const graph_element& element() const; /// Return the graph element id. /// FIXME: we do not want to have this member since there is an diff --git a/milena/mln/core/image/image1d.hh b/milena/mln/core/image/image1d.hh index 701a0f5..0cac67d 100644 --- a/milena/mln/core/image/image1d.hh +++ b/milena/mln/core/image/image1d.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -163,8 +163,10 @@ namespace mln image1d(const box1d& b, unsigned bdr = border::thickness); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const box1d& b, unsigned bdr = border::thickness); + /// \endcond /// Test if \p p is valid. @@ -192,6 +194,8 @@ namespace mln // Specific methods: // ----------------- + /// \cond INTERNAL_API + /// Read-only access to the image value located at (\p offset). const T& at_(def::coord offset) const; @@ -201,6 +205,7 @@ namespace mln /// Give the number of offsets. unsigned ninds() const; + /// \endcond /// Fast Image method @@ -232,9 +237,10 @@ namespace mln unsigned nelements() const; - + /// \cond INTERNAL_API /// Resize image border with new_border. void resize_(unsigned new_border); + /// \endcond }; diff --git a/milena/mln/core/image/image2d.hh b/milena/mln/core/image/image2d.hh index 31dc802..7ef0102 100644 --- a/milena/mln/core/image/image2d.hh +++ b/milena/mln/core/image/image2d.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -63,7 +63,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::image2d<T>. */ template <typename T> @@ -88,7 +87,6 @@ namespace mln } // end of namespace mln::internal - namespace trait { @@ -164,12 +162,10 @@ namespace mln image2d(const box2d& b, unsigned bdr = border::thickness); - /// @cond INTERNAL_API - + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const box2d& b, unsigned bdr = border::thickness); - - /// @endcond + /// \endcond /// Test if \p p is valid. @@ -214,15 +210,12 @@ namespace mln // Specific methods: // ----------------- - /// @cond INTERNAL_API - + /// \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 + /// \endcond /// Give the number of rows. @@ -263,24 +256,25 @@ namespace mln T* buffer(); - /// @cond INTERNAL_API - + /// \cond INTERNAL_API /// Resize image border with new_border. void resize_(unsigned new_border); - - /// @endcond + /// \endcond }; // Forward declaration + /// \cond INTERNAL_API + template <typename T> void init_(tag::border_t, unsigned& bdr, const image2d<T>& model); template <typename T, typename J> void init_(tag::image_t, mln::image2d<T>& target, const J& model); + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/image3d.hh b/milena/mln/core/image/image3d.hh index a5b6203..20831c5 100644 --- a/milena/mln/core/image/image3d.hh +++ b/milena/mln/core/image/image3d.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and -// Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 EPITA +// Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -171,8 +171,10 @@ namespace mln image3d(int nslis, int nrows, int ncols, unsigned bdr = border::thickness); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const box3d& b, unsigned bdr = border::thickness); + /// \endcond /// Test if \p p is valid. @@ -205,6 +207,8 @@ namespace mln /// Read-write access to the image value located at offset \p i. T& element(unsigned i); + /// \cond INTERNAL_API + /// Read-only access to the image value located at (\p sli, \p /// row, \p col). const T& at_(def::coord sli, def::coord row, def::coord col) const; @@ -213,6 +217,7 @@ namespace mln /// row, \p col). T& at_(def::coord sli, def::coord row, def::coord col); + /// \endcond /// Give the number of slices. unsigned nslis() const; @@ -238,14 +243,17 @@ namespace mln /// Give a hook to the value buffer. T* buffer(); + /// \cond INTERNAL_API + /// To use the track pointer inherited. using super_::data_; - /// Resize image border with new_border. void resize_(unsigned new_border); + /// \endcond + }; template <typename T, typename J> diff --git a/milena/mln/core/image/imorph/decorated_image.hh b/milena/mln/core/image/imorph/decorated_image.hh index 0287940..75e02be 100644 --- a/milena/mln/core/image/imorph/decorated_image.hh +++ b/milena/mln/core/image/imorph/decorated_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -61,7 +61,6 @@ namespace mln }; /*! - \internal \brief Data structure for \c mln::decorated_image<I,D>. */ template <typename I, typename D> @@ -102,8 +101,10 @@ namespace mln decorated_image(); decorated_image(I& ima, const D& deco); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(I& ima, const D& deco); + /// \endcond /// Dtor ~decorated_image(); @@ -117,8 +118,10 @@ namespace mln /// Read-write access of pixel value at point site \p p. lvalue operator()(const psite& p); + /// \cond INTERNAL_API /// Actual read routine. rvalue read_(const mln_psite(I)& p) const; + /// \endcond /// Const promotion via conversion. operator decorated_image<const I, D>() const; diff --git a/milena/mln/core/image/imorph/interpolated.hh b/milena/mln/core/image/imorph/interpolated.hh index d92dd0f..0c20ac3 100644 --- a/milena/mln/core/image/imorph/interpolated.hh +++ b/milena/mln/core/image/imorph/interpolated.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -51,7 +51,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::interpolated<I, F>. */ template <typename I, template <class> class F> @@ -112,8 +111,10 @@ namespace mln interpolated(I& ima); interpolated(); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(I& ima); + /// \endcond /// Test if this image has been initialized. diff --git a/milena/mln/core/image/imorph/labeled_image.hh b/milena/mln/core/image/imorph/labeled_image.hh index d62735f..b546fa0 100644 --- a/milena/mln/core/image/imorph/labeled_image.hh +++ b/milena/mln/core/image/imorph/labeled_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2010, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2009, 2010, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -63,7 +63,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::labeled_image. */ template <typename I> @@ -130,16 +129,20 @@ namespace mln const util::array<mln_box(I)>& bboxes); /// @} + /// \cond INTERNAL_API /// Deferred initialization from a labeled image \p ima and the number /// of labels \p nlabels. void init_(const I& ima, const mln_value(I)& nlabels); /// Duplicate the underlying image and create a new labeled_image. void init_from_(const labeled_image& model); + /// \endcond }; + /// \cond INTERNAL_API + // init_ //FIXME: not enough generic? We would like 'J' instead of @@ -147,7 +150,7 @@ namespace mln template <typename I, typename J> void init_(tag::image_t, labeled_image& target, const labeled_image<J>& model); - + /// \endcond namespace make diff --git a/milena/mln/core/image/imorph/lazy_image.hh b/milena/mln/core/image/imorph/lazy_image.hh index bcba84d..c394302 100644 --- a/milena/mln/core/image/imorph/lazy_image.hh +++ b/milena/mln/core/image/imorph/lazy_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Copyright (C) 2007, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -48,7 +48,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::lazy_image. */ template <typename I, typename F, typename B> @@ -119,8 +118,10 @@ namespace mln /// Constructors. lazy_image(const F& fun, const B& box); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const F& fun, const B& box); + /// \endcond /// Return domain of lazyd_image. const box<mln_psite(I)>& domain() const; diff --git a/milena/mln/core/image/imorph/plain.hh b/milena/mln/core/image/imorph/plain.hh index 8f862f4..0bd5ca9 100644 --- a/milena/mln/core/image/imorph/plain.hh +++ b/milena/mln/core/image/imorph/plain.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -48,7 +48,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::plain. */ template <typename I> @@ -105,8 +104,10 @@ namespace mln /// Copy constructor from an image \p ima. plain(const I& ima); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const I& ima); + /// \endcond /// Assignment operator. plain& operator=(const plain& rhs); diff --git a/milena/mln/core/image/imorph/safe.hh b/milena/mln/core/image/imorph/safe.hh index 37efd61..5a7636e 100644 --- a/milena/mln/core/image/imorph/safe.hh +++ b/milena/mln/core/image/imorph/safe.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -49,7 +49,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::safe_image. */ template <typename I> @@ -95,8 +94,10 @@ namespace mln safe_image(I& ima); safe_image(I& ima, const mln_value(I)& default_value); + /// \cond INTERNAL_API // Initialize an empty image. void init_(I& ima, const mln_value(I)& default_value); + /// \endcond mln_rvalue(I) operator()(const mln_psite(I)& p) const; diff --git a/milena/mln/core/image/imorph/tr_image.hh b/milena/mln/core/image/imorph/tr_image.hh index ad2b1af..3f2451f 100644 --- a/milena/mln/core/image/imorph/tr_image.hh +++ b/milena/mln/core/image/imorph/tr_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2009, 2012 EPITA Research and Development +// Copyright (C) 2007, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -49,7 +49,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::tr_image<S,I,T>. */ template <typename S, typename I, typename T> @@ -121,8 +120,10 @@ namespace mln if we do not provide set_ima(). */ tr_image(); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const S& s, const I& ima, const T& tr); + /// \endcond /// Test if this image has been initialized. bool is_valid() const; diff --git a/milena/mln/core/image/vertex_image.hh b/milena/mln/core/image/vertex_image.hh index 042423d..4710f17 100644 --- a/milena/mln/core/image/vertex_image.hh +++ b/milena/mln/core/image/vertex_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -195,8 +195,11 @@ namespace mln }; + + /// \cond INTERNAL_API template <typename P, typename V, typename G, typename J> void init_(tag::image_t, vertex_image<P,V,G>& target, const Image<J>& model); + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/image/vmorph/cast_image.hh b/milena/mln/core/image/vmorph/cast_image.hh index 9d6248c..57942c3 100644 --- a/milena/mln/core/image/vmorph/cast_image.hh +++ b/milena/mln/core/image/vmorph/cast_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,6 @@ namespace mln namespace internal { /*! - \internal \brief Data structure for \c mln::cast_image_<T,I>. */ template <typename T, typename I> @@ -136,8 +135,10 @@ namespace mln /// Constructor. cast_image_(const Image& ima); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const Image& ima); + /// \endcond /// Read-only access of pixel value at point site \p p. T operator()(const mln_psite(I)& p) const; diff --git a/milena/mln/core/image/vmorph/fun_image.hh b/milena/mln/core/image/vmorph/fun_image.hh index 66b2c1d..8d6e2ed 100644 --- a/milena/mln/core/image/vmorph/fun_image.hh +++ b/milena/mln/core/image/vmorph/fun_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -49,7 +49,6 @@ namespace mln namespace internal { /*! - \internal \brief Data structure for \c mln::fun_image<T,I>. */ template <typename F, typename I> @@ -124,8 +123,10 @@ namespace mln /// Constructor. fun_image(const Image& ima); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const Function_v2v<F>& f, const Image& ima); + /// \endcond /// Read-only access of pixel value at point site \p p. mln_result(F) operator()(const mln_psite(I)& p) const; diff --git a/milena/mln/core/image/vmorph/thru_image.hh b/milena/mln/core/image/vmorph/thru_image.hh index 7dd4d7a..f5552ac 100644 --- a/milena/mln/core/image/vmorph/thru_image.hh +++ b/milena/mln/core/image/vmorph/thru_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -51,7 +51,6 @@ namespace mln template <typename I, typename F> class thru_image_read; /*! - \internal \brief Find correct implementation */ template <typename I, typename F> @@ -67,7 +66,6 @@ namespace mln }; /*! - \internal \brief Data structure for \c mln::thru_image. */ template <typename I, typename F> @@ -167,7 +165,10 @@ namespace mln thru_image(I& ima); thru_image(I& ima, const F& f); + + /// \cond INTERNAL_API void init_(I& ima, const F& f); + /// \endcond /// Const promotion via conversion. operator thru_image<const I, F>() const; diff --git a/milena/mln/core/image/vmorph/violent_cast_image.hh b/milena/mln/core/image/vmorph/violent_cast_image.hh index e389902..0a68bcb 100644 --- a/milena/mln/core/image/vmorph/violent_cast_image.hh +++ b/milena/mln/core/image/vmorph/violent_cast_image.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2011, 2012 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2011, 2012, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -46,7 +46,6 @@ namespace mln namespace internal { /*! - \internal \brief Data structure for \c mln::violent_cast_image<T,I>. */ template <typename T, typename I> @@ -131,8 +130,10 @@ namespace mln /// Constructor. violent_cast_image(const Image& ima); + /// \cond INTERNAL_API /// Initialize an empty image. void init_(const Image& ima); + /// \endcond /// Read-only access of pixel value at point site \p p. T operator()(const mln_psite(I)& p) const; diff --git a/milena/mln/core/internal/classical_window_base.hh b/milena/mln/core/internal/classical_window_base.hh index 21f68c3..887a908 100644 --- a/milena/mln/core/internal/classical_window_base.hh +++ b/milena/mln/core/internal/classical_window_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,6 @@ namespace mln { /*! - \internal \brief Base class for classes based on a set of dpoints. */ template <typename D, typename E> diff --git a/milena/mln/core/internal/graph_psite_base.hh b/milena/mln/core/internal/graph_psite_base.hh index 4cef358..e8f2416 100644 --- a/milena/mln/core/internal/graph_psite_base.hh +++ b/milena/mln/core/internal/graph_psite_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -101,8 +101,10 @@ namespace mln /// Explicit conversion towards the graph element (vertex or edge). const typename S::graph_element& element() const; + /// \cond INTERNAL_API /// Return the underlying element. const typename S::graph_element& p_hook_() const; + /// \endcond protected: @@ -160,7 +162,6 @@ namespace mln /// \{ /*! - \internal \brief subject_impl specialization (Proxy) */ template <typename S, typename P, typename E> diff --git a/milena/mln/core/internal/image_base.hh b/milena/mln/core/internal/image_base.hh index c810547..1b068ca 100644 --- a/milena/mln/core/internal/image_base.hh +++ b/milena/mln/core/internal/image_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -61,7 +61,7 @@ namespace mln }; - /*! \internal + /*! \brief A base class for images. Parameter \p T is the image value type. @@ -146,7 +146,8 @@ namespace mln /// Copy constructor (performs a shallow copy). image_base(const image_base& rhs); - /// @cond INTERNAL_API + + /// \cond INTERNAL_API /*! \brief Give an identifier of this image. @@ -159,7 +160,7 @@ namespace mln /// \brief Hook to the image data. const util::tracked_ptr< internal::data<E> >& hook_data_() const; - /// @endcond + /// \endcond /// Detach data from an image (free it if nobody else hold it). @@ -170,8 +171,10 @@ namespace mln /// Constructor without argument. image_base(); - // Internal data, sharable by several images. + /// \cond INTERNAL_API + /// Internal data, sharable by several images. util::tracked_ptr< internal::data<E> > data_; + /// \endcond }; diff --git a/milena/mln/core/internal/image_identity.hh b/milena/mln/core/internal/image_identity.hh index a5055f6..1c502fc 100644 --- a/milena/mln/core/internal/image_identity.hh +++ b/milena/mln/core/internal/image_identity.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -121,7 +121,6 @@ namespace mln /*! - \internal \brief A base class for image morphers w.r.t. identity. Parameter \p S is a point set type. diff --git a/milena/mln/core/internal/image_morpher.hh b/milena/mln/core/internal/image_morpher.hh index 579230a..c16165c 100644 --- a/milena/mln/core/internal/image_morpher.hh +++ b/milena/mln/core/internal/image_morpher.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -59,23 +59,25 @@ namespace mln /// Delegatee associated type. typedef I delegatee; + /// \cond INTERNAL_API /// Return the delegatee_ pointer; default code. mlc_const(I)* delegatee_() const; /// Return the delegatee_ pointer (non-const version); default code. I* delegatee_(); - + /// \endcond /// Unmorph image associated type. typedef I unmorph; + /// \cond INTERNAL_API /// Give the morphed image (mutable version). I& unmorph_(); /// Give the morphed image (const version). mlc_const(I)& unmorph_() const; - + /// \endcond /* \brief Test if this image has been initialized; default impl. * @@ -111,10 +113,11 @@ namespace mln // FIXME: Lines above have been inactivated because they are either // prioritary or ambiguous. - + /// \cond INTERNAL_API template <typename Subject, typename T, typename J> void init_(Subject s, T& target, const Image<J>& model); + /// \endcond } // end of namespace mln::impl diff --git a/milena/mln/core/internal/labeled_image_base.hh b/milena/mln/core/internal/labeled_image_base.hh index 9c9466c..5aa269a 100644 --- a/milena/mln/core/internal/labeled_image_base.hh +++ b/milena/mln/core/internal/labeled_image_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2009, 2010, 2012 EPITA Research and Development +// Copyright (C) 2009, 2010, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -61,7 +61,6 @@ namespace mln { /*! - \internal \brief Data structure for \c mln::labeled_image_base<I,E>. */ template <typename I, typename E> @@ -104,7 +103,6 @@ namespace mln /*! - \internal \brief Base class Morpher providing an improved interface for labeled image. diff --git a/milena/mln/core/internal/neighb_base.hh b/milena/mln/core/internal/neighb_base.hh index 05d4b67..908f6cb 100644 --- a/milena/mln/core/internal/neighb_base.hh +++ b/milena/mln/core/internal/neighb_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -70,8 +70,10 @@ namespace mln void change_window(const W& new_win); - /// \internal Hook to the window. + /// \cond INTERNAL_API + /// \brief Hook to the window. W& hook_win_(); + /// \endcond private: diff --git a/milena/mln/core/internal/neighb_niter_base.hh b/milena/mln/core/internal/neighb_niter_base.hh index daa41db..9dd1ea0 100644 --- a/milena/mln/core/internal/neighb_niter_base.hh +++ b/milena/mln/core/internal/neighb_niter_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,7 +41,6 @@ namespace mln { /*! - \internal \brief Base implementation for neighborhood iterators. */ template <typename W, typename N, typename I, typename E> @@ -59,6 +58,7 @@ namespace mln template <typename P> neighb_niter_base(const N& nbh, const P& c); + /// \cond INTERNAL_API /// Test the iterator validity. bool is_valid_() const; @@ -73,7 +73,7 @@ namespace mln /// Compute the current psite. mln_psite(W) compute_p_() const; - + /// \endcond protected: I i_; diff --git a/milena/mln/core/internal/p_complex_piter_base.hh b/milena/mln/core/internal/p_complex_piter_base.hh index 9d4ff21..96e44e3 100644 --- a/milena/mln/core/internal/p_complex_piter_base.hh +++ b/milena/mln/core/internal/p_complex_piter_base.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -75,6 +76,7 @@ namespace mln /// Manipulation. /// \{ public: + /// \cond INTERNAL_API /// Test if the iterator is valid. bool is_valid_() const; /// Invalidate the iterator. @@ -87,6 +89,7 @@ namespace mln /// Change the target of the underlying complex iterator. void change_target_(const S& pc); + /// \endcond private: /// Update the psite. diff --git a/milena/mln/core/internal/piter_adaptor.hh b/milena/mln/core/internal/piter_adaptor.hh index fa84a43..4161a6e 100644 --- a/milena/mln/core/internal/piter_adaptor.hh +++ b/milena/mln/core/internal/piter_adaptor.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -46,7 +46,6 @@ namespace mln { /*! - \internal \brief A base class for point iterator adaptors. Parameter \c Pi is the type of the point iterator adaptee; @@ -63,6 +62,7 @@ namespace mln /// Constructor from a point iterator \p piter. piter_adaptor_(const Pi& piter); + /// \cond INTERNAL_API /// Test the iterator validity. bool is_valid_() const; @@ -78,12 +78,13 @@ namespace mln /// Hook to the current location. const mln_psite(S)& p_hook_() const; - /// Change the site set targeted by this iterator. - void change_target(const S& s); - /// Change the site set targeted by pi_. This default impl is a /// no-op. This method might be overridden. void pi_change_target_(const S& s); + /// \endcond + + /// Change the site set targeted by this iterator. + void change_target(const S& s); protected: diff --git a/milena/mln/core/internal/pseudo_site_base.hh b/milena/mln/core/internal/pseudo_site_base.hh index 576428e..d756ed6 100644 --- a/milena/mln/core/internal/pseudo_site_base.hh +++ b/milena/mln/core/internal/pseudo_site_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -42,7 +42,6 @@ namespace mln { /*! - \internal \brief A base class for pseudo sites. Parameter \c P is FIXME: a point site type. diff --git a/milena/mln/core/internal/run_image.hh b/milena/mln/core/internal/run_image.hh index 1751b1b..1718444 100644 --- a/milena/mln/core/internal/run_image.hh +++ b/milena/mln/core/internal/run_image.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -43,7 +43,6 @@ namespace mln { /*! - \internal \brief Factorization class for run_image. Parameter \c T is the type of the image value. diff --git a/milena/mln/core/internal/set_of.hh b/milena/mln/core/internal/set_of.hh index cdc599c..4e4c4d7 100644 --- a/milena/mln/core/internal/set_of.hh +++ b/milena/mln/core/internal/set_of.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -47,7 +47,6 @@ namespace mln { /*! - \internal \brief An "efficient" mathematical set class. This set class is designed to store a mathematical set and to diff --git a/milena/mln/core/internal/site_iterator_base.hh b/milena/mln/core/internal/site_iterator_base.hh index 4f45287..ac8562c 100644 --- a/milena/mln/core/internal/site_iterator_base.hh +++ b/milena/mln/core/internal/site_iterator_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -75,12 +75,13 @@ namespace mln // ambiguities in very special cases since we inherit a couple // of conversions (const and non-const) - + /// \cond INTERNAL_API /// Give the subject (required by the Proxy interface). const mln_psite(S)& subj_(); /// Give the target address. It might be 0. const S*& target_(); + /// \endcond protected: diff --git a/milena/mln/core/internal/site_relative_iterator_base.hh b/milena/mln/core/internal/site_relative_iterator_base.hh index c091203..87b69b1 100644 --- a/milena/mln/core/internal/site_relative_iterator_base.hh +++ b/milena/mln/core/internal/site_relative_iterator_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -48,7 +48,6 @@ namespace mln { /*! - \internal \brief A generic iterator on points of windows and of neighborhoods. @@ -70,11 +69,13 @@ namespace mln template <typename P> void center_at(const P& c); + /// \cond INTERNAL_API /// Start an iteration. void start_(); /// Go to the next point. void next_(); + /// \endcond /// Give the site set (neighborhood or window) that this /// iterator browses. @@ -83,6 +84,7 @@ namespace mln /// The psite around which this iterator moves. const C& center() const; + /// \cond INTERNAL_API /// This overriding is very useful: it adds a test to prevent /// getting an invalid iterator when its center has moved. Some /// sub-classes provide an update() method for the client to say @@ -92,6 +94,7 @@ namespace mln /// Hook to the current location. const mln_psite(S)& p_hook_() const; + /// \endcond /// Change the site set targeted by this iterator. void change_target(const S& s); diff --git a/milena/mln/core/internal/site_set_base.hh b/milena/mln/core/internal/site_set_base.hh index 191a16c..269efab 100644 --- a/milena/mln/core/internal/site_set_base.hh +++ b/milena/mln/core/internal/site_set_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -44,7 +44,6 @@ namespace mln /*! - \internal \brief A base class for site set classes. \tparam P The psite type of what is ``contained'' in the site diff --git a/milena/mln/core/internal/site_set_impl.hh b/milena/mln/core/internal/site_set_impl.hh index 4e0e49f..7f9fff7 100644 --- a/milena/mln/core/internal/site_set_impl.hh +++ b/milena/mln/core/internal/site_set_impl.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // diff --git a/milena/mln/core/internal/site_set_iterator_base.hh b/milena/mln/core/internal/site_set_iterator_base.hh index 0b85fbb..9134536 100644 --- a/milena/mln/core/internal/site_set_iterator_base.hh +++ b/milena/mln/core/internal/site_set_iterator_base.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -62,15 +62,17 @@ namespace mln /// Give the site set that this iterator browses. const S& site_set() const; - /// Hook to the current location. - const mln_psite(S)& p_hook_() const; - /// Change the site set targeted by this iterator. void change_target(const S& s); + /// \cond INTERNAL_API + /// Hook to the current location. + const mln_psite(S)& p_hook_() const; + /// Part of the change_target specific to the exact iterator /// type, empty by default (to be overloaded). void change_target_(const S& s); + /// \endcond protected: diff --git a/milena/mln/core/internal/window_base.hh b/milena/mln/core/internal/window_base.hh index bfe8da5..f6c0c66 100644 --- a/milena/mln/core/internal/window_base.hh +++ b/milena/mln/core/internal/window_base.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -63,9 +63,15 @@ namespace mln /// Type of the window center typedef psite center_t; - /// Test if this window can be a neighborhood. - // This method is used in the neighborhood window-adapter. + + /// \cond INTERNAL_API + /*! + \brief Test if this window can be a neighborhood. + + This method is used in the neighborhood window-adapter. + */ bool is_neighbable_() const; + /// \endcond /// return true by default. bool is_valid() const; diff --git a/milena/mln/core/mixed_neighb.hh b/milena/mln/core/mixed_neighb.hh index 2c89131..e95e0e9 100644 --- a/milena/mln/core/mixed_neighb.hh +++ b/milena/mln/core/mixed_neighb.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -83,16 +83,17 @@ namespace mln }; - /// \internal Conversion: mixed_neighb<W> -> W + /// \cond INTERNAL_API + /// Conversion: mixed_neighb<W> -> W template <typename W> void from_to_(const mln::mixed_neighb<W>& from, W& to); - /// \internal Conversion: mixed_neighb<W> -> W + /// Conversion: mixed_neighb<W> -> W template <typename W> void from_to_(const W& from, mln::mixed_neighb<W>& to); - + /// \endcond // mixed_neighb_fwd_niter<W> diff --git a/milena/mln/core/neighb.hh b/milena/mln/core/neighb.hh index e2e083b..93e17f2 100644 --- a/milena/mln/core/neighb.hh +++ b/milena/mln/core/neighb.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -81,15 +81,17 @@ namespace mln }; - /// \internal Conversions: neighb<W> -> W + /// \cond INTERNAL_API + /// Conversions: neighb<W> -> W template <typename W> void from_to_(const mln::neighb<W>& from, W& to); - /// \internal Conversions: W -> neighb<W> + /// Conversions: W -> neighb<W> template <typename W> void from_to_(const W& from, mln::neighb<W>& to); + /// \endcond // neighb_fwd_niter<W> diff --git a/milena/mln/core/pixter1d.hh b/milena/mln/core/pixter1d.hh index 8a626da..0b15ae3 100644 --- a/milena/mln/core/pixter1d.hh +++ b/milena/mln/core/pixter1d.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -59,8 +59,10 @@ namespace mln /// \param[in] image The image this pixel iterator is bound to. fwd_pixter1d(I& image); + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); + /// \endcond }; @@ -86,8 +88,10 @@ namespace mln /// \param[in] image The image this pixel iterator is bound to. bkd_pixter1d(I& image); + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); + /// \endcond }; diff --git a/milena/mln/core/pixter2d.hh b/milena/mln/core/pixter2d.hh index 49011aa..2837543 100644 --- a/milena/mln/core/pixter2d.hh +++ b/milena/mln/core/pixter2d.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -61,6 +61,8 @@ namespace mln /// \param[in] image The image this pixel iterator is bound to. fwd_pixter2d(I& image); + + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); @@ -79,6 +81,8 @@ namespace mln mln_qlf_value(I)* eor_; using super_::image_; + + /// \endcond }; @@ -104,6 +108,8 @@ namespace mln /// \param[in] image The image this pixel iterator is bound to. bkd_pixter2d(I& image); + + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); @@ -122,6 +128,8 @@ namespace mln mln_qlf_value(I)* bor_; using super_::image_; + + /// \endcond }; diff --git a/milena/mln/core/pixter3d.hh b/milena/mln/core/pixter3d.hh index 93bad74..31d115c 100644 --- a/milena/mln/core/pixter3d.hh +++ b/milena/mln/core/pixter3d.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -45,7 +45,6 @@ namespace mln `------------------*/ /*! - \internal \brief Forward pixel iterator on a 3-D image with border. */ template <typename I> @@ -62,11 +61,13 @@ namespace mln /// \param[in] image The image this pixel iterator is bound to. fwd_pixter3d(I& image); + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); /// Extra code for start(). void start_(); + /// \endcond private: @@ -100,7 +101,6 @@ namespace mln `------------------*/ /*! - \internal \brief Backward pixel iterator on a 3-D image with border. */ template <typename I> @@ -117,11 +117,13 @@ namespace mln /// \param[in] image The image this pixel iterator is bound to. bkd_pixter3d(I& image); + /// \cond INTERNAL_API /// Go to the next pixel. void next_(); /// Extra code for start(). void start_(); + /// \endcond private: diff --git a/milena/mln/core/point.hh b/milena/mln/core/point.hh index 03afe57..552a8b7 100644 --- a/milena/mln/core/point.hh +++ b/milena/mln/core/point.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and -// Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 EPITA +// Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -201,7 +201,10 @@ namespace mln }; - /// \internal Conversion: point -> point + /*! + \brief Conversion: point -> point + \ingroup fromto + */ template <typename G, typename C1, typename C2> void from_to_(const point<G,C1>& from, point<G,C2>& to); @@ -230,13 +233,14 @@ namespace mln } // end of namespace mln::internal + /// \cond INTERNAL_API /// FIXME... template <typename G, typename C> const mln::algebra::vec<point<G,C>::dim - 1, C>& cut_(const point<G,C>& p); template <typename C> const util::yes& cut_(const point<grid::tick,C>& p); - + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/routine/init.hh b/milena/mln/core/routine/init.hh index 812712f..9b1f4ee 100644 --- a/milena/mln/core/routine/init.hh +++ b/milena/mln/core/routine/init.hh @@ -41,6 +41,7 @@ namespace mln { + /// \cond INTERNAL_API // Forward declaration. @@ -58,7 +59,7 @@ namespace mln template <typename I> void init_(tag::domain_t, mln_domain(I)& pset, const Image& ima); - + /// \endcond # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/core/site_set/box.hh b/milena/mln/core/site_set/box.hh index 4256dc4..aaaa8c3 100644 --- a/milena/mln/core/site_set/box.hh +++ b/milena/mln/core/site_set/box.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011 EPITA Research and +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2013 EPITA Research and // Development Laboratory (LRDE) // // This file is part of Olena. @@ -180,6 +180,7 @@ namespace mln /// Return the minimum box including box \p a and box \p b + /// \relates mln::box template <typename P> inline box diff --git a/milena/mln/core/site_set/box_piter.hh b/milena/mln/core/site_set/box_piter.hh index d3b548f..0d32567 100644 --- a/milena/mln/core/site_set/box_piter.hh +++ b/milena/mln/core/site_set/box_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -40,7 +40,6 @@ namespace mln { /*! - \internal \brief A generic forward iterator on points of boxes. The parameter \c P is the type of points. @@ -68,6 +67,7 @@ namespace mln /// box_fwd_piter_(const mln::box& b); + /// \cond INTERNAL_API /// Test the iterator validity. bool is_valid_() const; @@ -79,6 +79,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond protected: using super_::p_; @@ -88,7 +89,6 @@ namespace mln /*! - \internal \brief A generic backward iterator on points of boxes. The parameter \c P is the type of points. @@ -116,6 +116,7 @@ namespace mln /// box_bkd_piter_(const box& b); + /// \cond INTERNAL_API /// Test the iterator validity. bool is_valid_() const; @@ -127,6 +128,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond protected: using super_::p_; diff --git a/milena/mln/core/site_set/complex_psite.hh b/milena/mln/core/site_set/complex_psite.hh index c15c12d..8fce538 100644 --- a/milena/mln/core/site_set/complex_psite.hh +++ b/milena/mln/core/site_set/complex_psite.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -93,17 +93,22 @@ namespace mln /// \pre Member face_ is valid. const target& site_set() const; + /// \cond INTERNAL_API /// Get a pointer to the target site_set. const target* target_() const; + /// \endcond + /// Set the target site_set. void change_target(const target& new_target); /// \} + /// \cond INTERNAL_API /// Proxy manipulators. /// \{ /// Return the site corresponding to this psite. const mln_site(G)& subj_(); /// \} + /// \endcond /// Face handle manipulators. /// \{ @@ -157,6 +162,7 @@ namespace mln /// /// \pre Arguments \a lhs and \a rhs must belong to the same /// mln::p_complex. + /// \relates mln::complex_psite<D,G> /* FIXME: We probably want to relax this precondition: p_complex equality is too strong; prefer complex equality. */ template <unsigned D, typename G> @@ -168,6 +174,7 @@ namespace mln /// /// \pre Arguments \a lhs and \a rhs must belong to the same /// mln::p_complex. + /// \relates mln:complex_psite<D,G> /* FIXME: We probably want to relax this precondition: p_complex equality is too strong; prefer complex equality. */ template <unsigned D, typename G> @@ -181,6 +188,7 @@ namespace mln /// /// \pre Arguments \a lhs and \a rhs must belong to the same /// mln::p_complex. + /// \relates mln::complex_psite<D,G> /* FIXME: We probably want to relax this precondition: p_complex equality is too strong; prefer complex equality. */ template <unsigned D, typename G> @@ -189,7 +197,7 @@ namespace mln const complex_psite<D, G>& rhs); /// \} - + /// \relates mln::complex_psite<D,G> template <unsigned D, typename G> inline std::ostream& diff --git a/milena/mln/core/site_set/p_array.hh b/milena/mln/core/site_set/p_array.hh index 08a041e..db53424 100644 --- a/milena/mln/core/site_set/p_array.hh +++ b/milena/mln/core/site_set/p_array.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012 EPITA Research and -// Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2010, 2011, 2012, 2013 EPITA +// Research and Development Laboratory (LRDE) // // This file is part of Olena. // @@ -167,8 +167,10 @@ namespace mln /// Return the corresponding std::vector of points. const std::vector& std_vector() const; + /// \cond INTERNAL_API /// Hook to the std::vector. std::vector& hook_std_vector_(); + /// \endcond protected: @@ -196,8 +198,10 @@ namespace mln typedef S target_t; // To please g++-2.95. // Also read the 'todo' in mln/core/concept/pseudo_site.hh. - // As a Proxy: + /// \cond INTERNAL_API + /// As a Proxy: const element& subj_(); + /// \endcond // As Itself. @@ -211,7 +215,10 @@ namespace mln void inc_index(); void dec_index(); + /// \cond INTERNAL_API const S* target_() const; + /// \endcond + void change_target(const S& newtarget); bool is_valid() const; @@ -220,7 +227,9 @@ namespace mln operator int() const; // To interoperate, e.g., with fun::i2v expecting an int. operator unsigned() const; // To avoid ambiguity when an unsigned is expected. + /// \cond INTERNAL_API void update_() const; + /// \endcond private: @@ -232,7 +241,6 @@ namespace mln /*! - \internal \brief Forward iterator on sites of an indexed site set. */ template <typename S> @@ -252,6 +260,7 @@ namespace mln /// Constructor. p_indexed_fwd_piter(const S& s); + /// \cond INTERNAL_API /// Test if the iterator is valid. bool is_valid_() const; @@ -263,6 +272,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond /// Return the current index. int index() const; @@ -275,7 +285,6 @@ namespace mln /*! - \internal \brief Backward iterator on sites of an indexed site set. */ template <typename S> @@ -295,6 +304,7 @@ namespace mln /// Constructor. p_indexed_bkd_piter(const S& s); + /// \cond INTERNAL_API /// Test if the iterator is valid. bool is_valid_() const; @@ -306,6 +316,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond /// Return the current index. int index() const; @@ -322,15 +333,19 @@ namespace mln template <typename P, typename S> int index_of_in(const P&, const S&); + /// \relates p_indexed_psite template <typename S> int index_of_in(const p_indexed_psite<S>& p, const S& s); + /// \relates p_indexed_psite template <typename S, typename A> int index_of_in(const p_indexed_psite<S>& p, const A& a); + /// \relates p_indexed_psite template <typename S, typename A> int index_of_in(const p_indexed_fwd_piter<S>& p, const A& arr); + /// \relates p_indexed_psite template <typename S, typename A> int index_of_in(const p_indexed_bkd_piter<S>& p, const A& arr); diff --git a/milena/mln/core/site_set/p_centered.hh b/milena/mln/core/site_set/p_centered.hh index cf2bd5c..6398a55 100644 --- a/milena/mln/core/site_set/p_centered.hh +++ b/milena/mln/core/site_set/p_centered.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -145,6 +145,7 @@ namespace mln /// Constructor. p_centered_piter(const p_centered<W>& s); + /// \cond INTERNAL_API /// Test the iterator validity. bool is_valid_() const; @@ -156,6 +157,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond protected: using super_::p_; diff --git a/milena/mln/core/site_set/p_complex_piter.hh b/milena/mln/core/site_set/p_complex_piter.hh index ac52cb7..90115a6 100644 --- a/milena/mln/core/site_set/p_complex_piter.hh +++ b/milena/mln/core/site_set/p_complex_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2010, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2010, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,6 @@ namespace mln `-----------------------------*/ /*! - \internal \brief Forward iterator on (all) the faces of an mln::p_complex<D, G>. */ template <unsigned D, typename G> @@ -79,7 +78,6 @@ namespace mln `-----------------------------*/ /*! - \internal \brief Backward iterator on (all) the faces of an mln::p_complex<D, G>. */ template <unsigned D, typename G> diff --git a/milena/mln/core/site_set/p_double.hh b/milena/mln/core/site_set/p_double.hh index a1fe528..f40f811 100644 --- a/milena/mln/core/site_set/p_double.hh +++ b/milena/mln/core/site_set/p_double.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -55,12 +56,14 @@ namespace mln // Target associated type. typedef S target; + /// \cond INTERNAL_API const S* target_() const; + /// \endcond void change_target(const S& newtarget); bool is_valid() const; - + unsigned index() const; const mln_psite(Sp)& p() const; @@ -68,8 +71,10 @@ namespace mln void change_p(const mln_psite(Sp)& p); + /// \cond INTERNAL_API // As a Proxy: const mln_psite(Sp)& subj_(); + /// \endcond private: @@ -98,7 +103,7 @@ namespace mln /// Constructor. p_double_piter(const S& s); - /// Change the site set targeted by this iterator. + /// Change the site set targeted by this iterator. void change_target(const S& newtarget); /// Test if the iterator is valid. @@ -146,7 +151,7 @@ namespace mln { return p_; } - + template <typename S, typename Sp> inline const S* @@ -194,7 +199,7 @@ namespace mln { i_ = i; } - + template <typename S, typename Sp> inline void diff --git a/milena/mln/core/site_set/p_edges_psite.hh b/milena/mln/core/site_set/p_edges_psite.hh index 9b0a0fa..6a4636e 100644 --- a/milena/mln/core/site_set/p_edges_psite.hh +++ b/milena/mln/core/site_set/p_edges_psite.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -72,15 +72,17 @@ namespace mln }; - + /// \relates p_edges_psite template <typename G, typename F> bool operator==(const p_edges_psite<G,F>& lhs, const p_edges_psite<G,F>& rhs); + /// \relates p_edges_psite template <typename G, typename F> bool operator!=(const p_edges_psite<G,F>& lhs, const p_edges_psite<G,F>& rhs); + /// \relates p_edges_psite template <typename G, typename F> bool operator<(const p_edges_psite<G,F>& lhs, const p_edges_psite<G,F>& rhs); diff --git a/milena/mln/core/site_set/p_faces.hh b/milena/mln/core/site_set/p_faces.hh index 09fa2fc..08af443 100644 --- a/milena/mln/core/site_set/p_faces.hh +++ b/milena/mln/core/site_set/p_faces.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2011 EPITA Research and Development +// Copyright (C) 2008, 2009, 2011, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -168,6 +168,7 @@ namespace mln /// /// Two mln::p_faces's are considered equal if they share the /// same complex. + /// \relates p_faces template <unsigned N, unsigned D, typename P> bool operator==(const p_faces<N, D, P>& lhs, const p_faces<N, D, P>& rhs); @@ -180,6 +181,7 @@ namespace mln /// /// \todo Refine this later, when we are able to express subcomplex /// relations. + /// \relates p_faces template <unsigned N, unsigned D, typename P> bool operator<=(const p_faces<N, D, P>& lhs, const p_faces<N, D, P>& rhs); diff --git a/milena/mln/core/site_set/p_graph_piter.hh b/milena/mln/core/site_set/p_graph_piter.hh index 2a52048..18d45ee 100644 --- a/milena/mln/core/site_set/p_graph_piter.hh +++ b/milena/mln/core/site_set/p_graph_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -72,6 +72,7 @@ namespace mln p_graph_piter(const S& pv); /// \} + /// \cond INTERNAL_API /// Manipulation. /// \{ /// Test if the iterator is valid. @@ -84,6 +85,7 @@ namespace mln /// Go to the next point. void next_(); /// \} + /// \endcond /// Return the underlying graph element. mln_q_subject(iter) element(); @@ -91,8 +93,10 @@ namespace mln /// Return the graph associated to the target S. const typename S::graph_t& graph() const; + /// \cond INTERNAL_API /// Return the underlying graph element iterator. const iter& hook_elt_() const; + /// \endcond /// Return the graph element id. unsigned id() const; @@ -117,7 +121,6 @@ namespace mln /// \{ /*! - \internal \brief subject_impl specialization (Proxy) */ template <typename S, typename I, typename E> diff --git a/milena/mln/core/site_set/p_if.hh b/milena/mln/core/site_set/p_if.hh index 06ae5c6..f8176fe 100644 --- a/milena/mln/core/site_set/p_if.hh +++ b/milena/mln/core/site_set/p_if.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -65,6 +66,8 @@ namespace mln * \param[in] s A site set. * \param[in] f A function from point to Boolean. * \return A subset of points. + * + * \relates p_if */ template <typename S, typename F> p_if<S, F> diff --git a/milena/mln/core/site_set/p_if_piter.hh b/milena/mln/core/site_set/p_if_piter.hh index 7820d40..83f8cef 100644 --- a/milena/mln/core/site_set/p_if_piter.hh +++ b/milena/mln/core/site_set/p_if_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -41,7 +41,6 @@ namespace mln /*! - \internal \brief Iterator on site sets conditionned by a function. Parameter \c S is a site set type; parameter F is a function @@ -61,6 +60,7 @@ namespace mln /// Constructor from a site set. p_if_piter_(const p_if<S,F>& s); + /// \cond INTERNAL_API /// Start an iteration. void start_(); @@ -69,6 +69,7 @@ namespace mln /// Change the set site targeted by pi_. void pi_change_target_(const p_if<S,F>& s); + /// \endcond private: typedef p_if_piter_<Pi,S,F> self_; diff --git a/milena/mln/core/site_set/p_image.hh b/milena/mln/core/site_set/p_image.hh index 9c669e4..2f0eef5 100644 --- a/milena/mln/core/site_set/p_image.hh +++ b/milena/mln/core/site_set/p_image.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -76,7 +77,7 @@ namespace mln public: typedef p_if<S_, F_> ret; }; - + } // end of namespace internal @@ -132,13 +133,13 @@ namespace mln unsigned nsites() const; - /// Insertion element associated type. + /// Insertion element associated type. typedef psite i_element; /// Insert a site \p p. void insert(const psite& p); - /// Removal element associated type. + /// Removal element associated type. typedef psite r_element; /// Remove a site \p p. @@ -157,8 +158,10 @@ namespace mln void clear(); + /// \cond INTERNAL_API /// Hook to the image const I& image_hook_() const; + /// \endcond private: diff --git a/milena/mln/core/site_set/p_key.hh b/milena/mln/core/site_set/p_key.hh index 31a5ab6..b28556b 100644 --- a/milena/mln/core/site_set/p_key.hh +++ b/milena/mln/core/site_set/p_key.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -124,7 +125,9 @@ namespace mln void insert(const K& k, const P& p); + /// \cond INTERNAL_API void unsafe_insert_(const K& k, const P& p); + /// \endcond @@ -165,10 +168,11 @@ namespace mln /// Test if the \p priority exists. bool exists_key(const K& key) const; - + /// \cond INTERNAL_API // Required by p_double-related classes. const util::set<K>& set_1_() const; const p_set& set_2_(const K& key) const; + /// \endcond /// Return the size of this site set in memory. @@ -195,7 +199,7 @@ namespace mln }; - + /// \relates p_key template <typename K, typename P> std::ostream& operator<<(std::ostream& ostr, const p_key<K,P>& pk); diff --git a/milena/mln/core/site_set/p_line2d.hh b/milena/mln/core/site_set/p_line2d.hh index d7ea7aa..1cbd3f6 100644 --- a/milena/mln/core/site_set/p_line2d.hh +++ b/milena/mln/core/site_set/p_line2d.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // diff --git a/milena/mln/core/site_set/p_mutable_array_of.hh b/milena/mln/core/site_set/p_mutable_array_of.hh index 4c82f2e..43dabbd 100644 --- a/milena/mln/core/site_set/p_mutable_array_of.hh +++ b/milena/mln/core/site_set/p_mutable_array_of.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -138,13 +139,15 @@ namespace mln /// Clear this set. void clear(); + /// \cond INTERNAL_API /// Test if the site set is empty. bool is_empty_() const; // Override the default impl since we have not .nsites(). - + /// \endcond /// Return the size of this site set in memory. std::size_t memory_size() const; + /// \cond INTERNAL_API /// Hook to the set of runs. const util::array<S>& array_hook_() const; @@ -153,6 +156,7 @@ namespace mln const util::array<S>& set_1_() const; template <typename I> const S& set_2_(const I& it) const; + /// \endcond protected: @@ -161,7 +165,7 @@ namespace mln }; - + /// \relates p_mutable_array_of template <typename S> std::ostream& operator<<(std::ostream& ostr, const p_mutable_array_of<S>& r); diff --git a/milena/mln/core/site_set/p_priority.hh b/milena/mln/core/site_set/p_priority.hh index a6ae004..5305661 100644 --- a/milena/mln/core/site_set/p_priority.hh +++ b/milena/mln/core/site_set/p_priority.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -166,10 +167,11 @@ namespace mln /// \pre ! is_empty() const P lowest_priority() const; - + /// \cond INTERNAL_API // Required by p_double-related classes. const util::set& set_1_() const; const Q& set_2_(const P& priority) const; + /// \endcond /// Return the size of this site set in memory. @@ -189,7 +191,7 @@ namespace mln }; - + /// \relates p_priority template <typename P, typename Q> std::ostream& operator<<(std::ostream& ostr, const p_priority<P,Q>& pq); diff --git a/milena/mln/core/site_set/p_run.hh b/milena/mln/core/site_set/p_run.hh index 51cef1f..07048a2 100644 --- a/milena/mln/core/site_set/p_run.hh +++ b/milena/mln/core/site_set/p_run.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -165,6 +166,7 @@ namespace mln }; + /// \relates mln::p_run template <typename P> std::ostream& operator<<(std::ostream& ostr, const p_run& r); @@ -198,7 +200,10 @@ namespace mln void inc_index(); void dec_index(); + /// \cond INTERNAL_API const p_run* target_() const; + /// \endcond + void change_target(const p_run& new_target); bool is_valid() const; diff --git a/milena/mln/core/site_set/p_run_piter.hh b/milena/mln/core/site_set/p_run_piter.hh index 1495723..d5a3524 100644 --- a/milena/mln/core/site_set/p_run_piter.hh +++ b/milena/mln/core/site_set/p_run_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -40,7 +40,6 @@ namespace mln { /*! - \internal \brief Forward iterator on points of a p_run. */ template <typename P> @@ -59,6 +58,7 @@ namespace mln /// Coordinate associated type. p_run_fwd_piter_(const p_run& r); + /// \cond INTERNAL_API /// Test if the iterator is valid. bool is_valid_() const; @@ -70,6 +70,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond protected: using super_::p_; @@ -79,7 +80,6 @@ namespace mln /*! - \internal \brief Backward iterator on points of a p_run. */ template <typename P> @@ -98,6 +98,7 @@ namespace mln /// Coordinate associated type. p_run_bkd_piter_(const p_run& r); + /// \cond INTERNAL_API /// Test if the iterator is valid. bool is_valid_() const; @@ -109,6 +110,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond protected: using super_::p_; diff --git a/milena/mln/core/site_set/p_set_of.hh b/milena/mln/core/site_set/p_set_of.hh index 6e47e1d..8192b0d 100644 --- a/milena/mln/core/site_set/p_set_of.hh +++ b/milena/mln/core/site_set/p_set_of.hh @@ -1,4 +1,5 @@ -// Copyright (C) 2008, 2009 EPITA Research and Development Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -134,10 +135,12 @@ namespace mln const util::set<S>& set_hook_() const; + /// \cond INTERNAL_API // Required by p_double-related classes. const util::set<S>& set_1_() const; template <typename I> const S& set_2_(const I& it) const; + /// \endcond protected: @@ -146,7 +149,7 @@ namespace mln }; - + /// \relates mln::p_set_of template <typename S> std::ostream& operator<<(std::ostream& ostr, const p_set_of<S>& s); diff --git a/milena/mln/core/site_set/p_transformed.hh b/milena/mln/core/site_set/p_transformed.hh index 2b597a5..33ba3f5 100644 --- a/milena/mln/core/site_set/p_transformed.hh +++ b/milena/mln/core/site_set/p_transformed.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2011 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2011, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -65,6 +65,8 @@ namespace mln /// \param[in] f A function from site to site. /// /// \return The transformed site set. + /// + /// \relates p_transformed<S,F> // template <typename S, typename F> p_transformed<S, F> diff --git a/milena/mln/core/site_set/p_transformed_piter.hh b/milena/mln/core/site_set/p_transformed_piter.hh index 505c72d..b2bb904 100644 --- a/milena/mln/core/site_set/p_transformed_piter.hh +++ b/milena/mln/core/site_set/p_transformed_piter.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2009, 2012 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2009, 2012, 2013 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of Olena. // @@ -41,7 +41,6 @@ namespace mln /*! - \internal \brief Iterator on p_transformed<S,F>. Parameter \c S is a site set type; parameter F is a function @@ -60,6 +59,7 @@ namespace mln /// Constructor from a site set. p_transformed_piter(const p_transformed<S,F>& s); + /// \cond INTERNAL_API /// Test the iterator validity. bool is_valid_() const; @@ -71,6 +71,7 @@ namespace mln /// Go to the next point. void next_(); + /// \endcond /// 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_vaccess.hh b/milena/mln/core/site_set/p_vaccess.hh index d7a753c..9d0b3cd 100644 --- a/milena/mln/core/site_set/p_vaccess.hh +++ b/milena/mln/core/site_set/p_vaccess.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -142,9 +142,11 @@ namespace mln /// Return the size of this site set in memory. std::size_t memory_size() const; + /// \cond INTERNAL_API // Required by p_double-related classes. const mln::value::set<V>& set_1_() const; const S& set_2_(const V& v) const; + /// \endcond protected: diff --git a/milena/mln/core/site_set/p_vertices_psite.hh b/milena/mln/core/site_set/p_vertices_psite.hh index a8b2cb2..7ca636e 100644 --- a/milena/mln/core/site_set/p_vertices_psite.hh +++ b/milena/mln/core/site_set/p_vertices_psite.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2008, 2009, 2012 EPITA Research and Development +// Copyright (C) 2008, 2009, 2012, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -68,14 +68,17 @@ namespace mln }; + /// \relates p_vertices_psite template <typename G, typename F> bool operator==(const p_vertices_psite<G,F>& lhs, const p_vertices_psite<G,F>& rhs); + /// \relates p_vertices_psite template <typename G, typename F> bool operator!=(const p_vertices_psite<G,F>& lhs, const p_vertices_psite<G,F>& rhs); + /// \relates p_vertices_psite template <typename G, typename F> bool operator<(const p_vertices_psite<G,F>& lhs, const p_vertices_psite<G,F>& rhs); @@ -85,7 +88,6 @@ namespace mln { /*! - \internal \brief Subject_impl (Proxy) */ template <typename G, typename F, typename E> diff --git a/milena/mln/core/w_window.hh b/milena/mln/core/w_window.hh index 1022dd5..fd608e5 100644 --- a/milena/mln/core/w_window.hh +++ b/milena/mln/core/w_window.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -141,14 +141,15 @@ namespace mln template <typename D, typename Wl, typename Wr> bool operator==(const w_window<D,Wl>& lhs, const w_window<D,Wr>& rhs); - - /// \internal Conversions: w_window -> image + /// \cond INTERNAL_API + /// Conversions: w_window -> image template <typename D, typename W, typename I> void from_to_(const w_window<D,W>& from, Image& to); - /// \internal Conversions: weight[] -> w_window + /// Conversions: weight[] -> w_window template <typename V, unsigned S, typename D, typename W> void from_to_(const V (&weight)[S], w_window<D,W>& to); + /// \endcond diff --git a/milena/mln/core/window.hh b/milena/mln/core/window.hh index a6d5373..4300619 100644 --- a/milena/mln/core/window.hh +++ b/milena/mln/core/window.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -175,8 +175,10 @@ namespace mln /// Give the std vector of delta-points. const std::vector<D>& std_vector() const; - /// Hook to the set of D. + /// \cond INTERNAL_API + /// \brief Hook to the set of D. const mln::util::set<D>& dps_hook_() const; + /// \endcond /// Print the window definition into \p ostr. void print(std::ostream& ostr) const; diff --git a/milena/mln/util/array.hh b/milena/mln/util/array.hh index 76c05fe..3fd987d 100644 --- a/milena/mln/util/array.hh +++ b/milena/mln/util/array.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2008, 2009, 2011, 2012 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2008, 2009, 2011, 2012, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -196,37 +196,40 @@ namespace mln /// Operator<<. + /// \relates util::array template <typename T> std::ostream& operator<<(std::ostream& ostr, const array<T>& a); /// Operator== + /// \relates util::array template <typename T> bool operator==(const array<T>& lhs, const array<T>& rhs); - /// \internal Conversion: array -> array + /// \cond INTERNAL_API + /// Conversion: array -> array template <typename T1, typename T2> void from_to_(const array<T1>& from, array<T2>& to); - /// \internal Conversion: array<T> -> fun::i2v::array<T> + /// Conversion: array<T> -> fun::i2v::array<T> template <typename T> inline void from_to_(const array<T>& from, fun::i2v::array<T>& to); - /// \internal Conversion: array<T> -> fun::i2v::array + /// Conversion: array<T> -> fun::i2v::array template <typename T, typename U> inline void from_to_(const array<T>& from, fun::i2v::array& to); - /// \internal Conversion: util::array -> image1d. + ///Conversion: util::array -> image1d. template <typename V, typename T> void from_to_(const util::array<V>& from, image1d<T>& to); - + /// \endcond // array_fwd_iter<T> @@ -587,7 +590,6 @@ namespace mln } template <typename T> - inline void from_to_(const array<T>& from, fun::i2v::array<T>& to) { @@ -595,7 +597,6 @@ namespace mln } template <typename T, typename U> - inline void from_to_(const array<T>& from, fun::i2v::array& to) { @@ -605,7 +606,6 @@ namespace mln } template <typename V, typename T> - inline void from_to_(const array<V>& from, image1d<T>& to) { -- 1.7.2.5

1 0

branch unstable/scribo updated: olena-2.0-469-g5a67b47
by git＠lrde.epita.fr 10 Apr '13

10 Apr '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch unstable/scribo has been updated discards 4440fda1f38a89860a17a08a7794dcd93aa53e36 (commit) discards d56053863dbf752b967c2d2351558313255a210d (commit) discards 3634a0dd2d93538c5af7962f47c7a585cd9506ae (commit) via 5a67b47545170fd6ad5ce94bd1cb5b7edca55e9b (commit) via 731ab1a14efd7c99632127b3f7515bfb2d53c98b (commit) via 375b4e61b2c1bf292088f7ff3b5f020180a72770 (commit) This update added new revisions after undoing existing revisions. That is to say, the old revision is not a strict subset of the new revision. This situation occurs when you --force push a change and generate a repository containing something like this: * -- * -- B -- O -- O -- O (4440fda1f38a89860a17a08a7794dcd93aa53e36) \ N -- N -- N (5a67b47545170fd6ad5ce94bd1cb5b7edca55e9b) When this happens we assume that you've already had alert emails for all of the O revisions, and so we here report only the revisions in the N branch from the common base, B. Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- 5a67b47 doc/Makefile.am: Fix permissions on documentation files. 731ab1a doc/Makefile.am: Fix permissions on documentation files. 375b4e6 doc/Makefile.am: Fix permissions on documentation files. ----------------------------------------------------------------------- Summary of changes: doc/Makefile.am | 2 +- milena/doc/Makefile.am | 2 +- scribo/doc/Makefile.am | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

branch exp/rpm-packages updated: olena-2.0-65-g24eb291
by git＠lrde.epita.fr 10 Apr '13

10 Apr '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch exp/rpm-packages has been updated via 24eb2911e7edea6e29f5a59de8da356f79596454 (commit) from 669afb2e042fb5175b7ee83c5d29908c3cb9ddf1 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- 24eb291 Update spec file for Olena 2.0. ----------------------------------------------------------------------- Summary of changes: ChangeLog | 10 +++ distrib/rpm/olena-1.0-linkage.patch | 14 +++++ distrib/rpm/olena-1.0-subdirs.patch | 35 ++++++++++++ distrib/rpm/olena-2.0-tesseract-3.01.patch | 66 ++++++++++++++++++++++ distrib/rpm/olena.spec | 83 +++++++++++++++++++++------ 5 files changed, 189 insertions(+), 19 deletions(-) create mode 100644 distrib/rpm/olena-1.0-linkage.patch create mode 100644 distrib/rpm/olena-1.0-subdirs.patch create mode 100644 distrib/rpm/olena-2.0-tesseract-3.01.patch hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0

olena-2.0-65-g24eb291 Update spec file for Olena 2.0.
by Guillaume Lazzara 10 Apr '13

10 Apr '13

* distrib/rpm/olena-1.0-linkage.patch, * distrib/rpm/olena-1.0-subdirs.patch, * distrib/rpm/olena-2.0-tesseract-3.01.patch: New. * distrib/rpm/olena.spec: Update to support Olena 2.0. --- ChangeLog | 10 +++ distrib/rpm/olena-1.0-linkage.patch | 14 +++++ distrib/rpm/olena-1.0-subdirs.patch | 35 ++++++++++++ distrib/rpm/olena-2.0-tesseract-3.01.patch | 66 ++++++++++++++++++++++ distrib/rpm/olena.spec | 83 +++++++++++++++++++++------ 5 files changed, 189 insertions(+), 19 deletions(-) create mode 100644 distrib/rpm/olena-1.0-linkage.patch create mode 100644 distrib/rpm/olena-1.0-subdirs.patch create mode 100644 distrib/rpm/olena-2.0-tesseract-3.01.patch diff --git a/ChangeLog b/ChangeLog index 95c83b4..aae6f78 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,15 @@ 2013-04-10 Guillaume Lazzara <z(a)lrde.epita.fr> + Update spec file for Olena 2.0. + + * distrib/rpm/olena-1.0-linkage.patch, + * distrib/rpm/olena-1.0-subdirs.patch, + * distrib/rpm/olena-2.0-tesseract-3.01.patch: New. + + * distrib/rpm/olena.spec: Update to support Olena 2.0. + +2013-04-10 Guillaume Lazzara <z(a)lrde.epita.fr> + * distrib/rpm/olena.spec: New. 2012-06-07 Guillaume Lazzara <z(a)lrde.epita.fr> diff --git a/distrib/rpm/olena-1.0-linkage.patch b/distrib/rpm/olena-1.0-linkage.patch new file mode 100644 index 0000000..dcd3949 --- /dev/null +++ b/distrib/rpm/olena-1.0-linkage.patch @@ -0,0 +1,14 @@ +--- external/trimesh/gluit/Makefile.am.link 2010-05-08 17:08:54.000000000 +0200 ++++ external/trimesh/gluit/Makefile.am 2010-05-08 17:10:33.000000000 +0200 +@@ -20,10 +20,10 @@ + # Find config.h. + AM_CPPFLAGS = -I$(top_builddir) + AM_CPPFLAGS += -I$(top_srcdir)/include -I$(top_srcdir)/include/GL +-AM_LDFLAGS = -lGL -lGLU -lX11 + + lib_LTLIBRARIES = libgluit.la + ++libgluit_la_LIBADD = -lGL -lGLU -lX11 -lxcb + libgluit_la_SOURCES = \ + glui_algebra3.h \ + glui_arcball.h \ \ No newline at end of file diff --git a/distrib/rpm/olena-1.0-subdirs.patch b/distrib/rpm/olena-1.0-subdirs.patch new file mode 100644 index 0000000..8488bdf --- /dev/null +++ b/distrib/rpm/olena-1.0-subdirs.patch @@ -0,0 +1,35 @@ +--- milena/Makefile.am.new 2009-09-14 15:10:30.000000000 -0300 ++++ milena/Makefile.am 2009-09-14 15:10:55.000000000 -0300 +@@ -19,7 +19,6 @@ + ## Process this file through Automake to create Makefile.in. + + SUBDIRS = \ +- doc \ + mesh \ + tests + +@@ -31,14 +30,7 @@ + SUBDIRS += tools + endif ENABLE_TOOLS + +-.PHONY: doc tutorial pretty-check tests +- +-doc: +- cd doc && $(MAKE) $(AM_MAKEFLAGS) $@ +- +-# FIXME: This target has no trigger in the top-level. +-tutorial: +- cd doc && $(MAKE) $(AM_MAKEFLAGS) $@ ++.PHONY: tutorial pretty-check tests + + pretty-check: + cd tests && $(MAKE) $(AM_MAKEFLAGS) $@ +@@ -48,7 +40,7 @@ + + # Regen files recursively. + include $(top_srcdir)/build-aux/regen-recursive.mk +-REGEN_SUBDIRS += doc tests ++REGEN_SUBDIRS += tests + + # Force the regeneration of `headers.mk'. + # diff --git a/distrib/rpm/olena-2.0-tesseract-3.01.patch b/distrib/rpm/olena-2.0-tesseract-3.01.patch new file mode 100644 index 0000000..eb1350f --- /dev/null +++ b/distrib/rpm/olena-2.0-tesseract-3.01.patch @@ -0,0 +1,66 @@ +Index: scribo/scribo/text/recognition.hh +=================================================================== +--- scribo/scribo/text/recognition.hh (revision dd1061b049328e5e45cb02150ec01aa9c9d3dd66) ++++ scribo/scribo/text/recognition.hh (revision 3b03179e7f4d5bd9354bdfbcc897dfd47968fe05) +@@ -113,5 +113,5 @@ + # else // HAVE_TESSERACT_3 + tesseract::TessBaseAPI tess; +- if (tess.Init(NULL, language, NULL, 0, false) == -1) ++ if (tess.Init(NULL, language, tesseract::OEM_DEFAULT) == -1) + { + std::cout << "Error: cannot initialize tesseract!" << std::endl; +@@ -221,5 +221,5 @@ + # else // HAVE_TESSERACT_3 + tesseract::TessBaseAPI tess; +- if (tess.Init(NULL, language, NULL, 0, false) == -1) ++ if (tess.Init(NULL, language, tesseract::OEM_DEFAULT) == -1) + { + std::cout << "Error: cannot initialize tesseract!" << std::endl; + +Index: m4/oln-with-lib.m4 +=================================================================== +--- m4/oln-with-lib.m4 (revision 40966ccf914d0289ee0e84c049b06f3606af738e) ++++ m4/oln-with-lib.m4 (revision b340c526ae583ce7be9ea28b63bf98f25aae1add) +@@ -1,6 +1,6 @@ + # -*- Autoconf -*- + +-# Copyright (C) 2009, 2010 EPITA Research and Development Laboratory +-# (LRDE) ++# Copyright (C) 2009, 2010, 2011 EPITA Research and Development ++# Laboratory (LRDE) + # + # This file is part of Olena. +@@ -84,17 +84,25 @@ + + if test "x$with_tesseract" != xno; then +- # Checking for Tesseract 3.x +- _OLN_WITH_LIB_SHARED_IMPL([TESSERACT], [tesseract/baseapi.h], [tesseract_api], ++ # Checking for Tesseract 3.x (single lib) ++ _OLN_WITH_LIB_SHARED_IMPL([TESSERACT], [tesseract/baseapi.h], [tesseract], + [tesseract], [TESSERACT_3], []) + + if test x$oln_have_tesseract != xyes; then +- # Tesseract 2.x not found, checking for Tesseract 2.x +- _OLN_WITH_LIB_SHARED_IMPL([TESSERACT], [tesseract/baseapi.h], [tesseract_full], ++ # Checking for Tesseract 3.x (multiple lib) ++ _OLN_WITH_LIB_SHARED_IMPL([TESSERACT], [tesseract/baseapi.h], [tesseract_api], ++ [tesseract], [TESSERACT_3], []) ++ if test x$oln_have_tesseract != xyes; then ++ # Tesseract 3.x not found, checking for Tesseract 2.x ++ _OLN_WITH_LIB_SHARED_IMPL([TESSERACT], [tesseract/baseapi.h], [tesseract_full], + [tesseract], [TESSERACT_2], []) +- TESSERACT_CPPFLAGS="$TESSERACT_2_CPPFLAGS -DHAVE_TESSERACT_2" +- TESSERACT_LDFLAGS=$TESSERACT_2_LDFLAGS ++ TESSERACT_CPPFLAGS="$TESSERACT_2_CPPFLAGS -DHAVE_TESSERACT_2" ++ TESSERACT_LDFLAGS=$TESSERACT_2_LDFLAGS ++ else ++ TESSERACT_CPPFLAGS="$TESSERACT_3_CPPFLAGS -DHAVE_TESSERACT_3" ++ TESSERACT_LDFLAGS=$TESSERACT_3_LDFLAGS ++ fi + else +- TESSERACT_CPPFLAGS="$TESSERACT_3_CPPFLAGS -DHAVE_TESSERACT_3" +- TESSERACT_LDFLAGS=$TESSERACT_3_LDFLAGS ++ TESSERACT_CPPFLAGS="$TESSERACT_3_CPPFLAGS -DHAVE_TESSERACT_3" ++ TESSERACT_LDFLAGS=$TESSERACT_3_LDFLAGS + fi + fi \ No newline at end of file diff --git a/distrib/rpm/olena.spec b/distrib/rpm/olena.spec index 37d285f..4bef325 100644 --- a/distrib/rpm/olena.spec +++ b/distrib/rpm/olena.spec @@ -1,9 +1,10 @@ %bcond_with apps -%bcond_with doc +%bcond_without doc +%bcond_without scribo Name: olena -Version: 1.0 -Release: %mkrel 4 +Version: 2.0 +Release: 3 Epoch: 2 License: GPLv2 Summary: Olena is a platform dedicated to image processing @@ -12,6 +13,8 @@ URL: http://www.lrde.epita.fr/cgi-bin/twiki/view/Olena/WebHome # Get from https://svn.lrde.epita.fr/svn/oln/tags/olena-1.0 to have scribo Source0: %name-%version.tar.bz2 Patch0: olena-1.0-subdirs.patch +Patch1: olena-1.0-linkage.patch +Patch2: olena-2.0-tesseract-3.01.patch BuildRoot: %{_tmppath}/%{name}-%{version}-root BuildRequires: cfitsio-devel BuildRequires: tiff-devel @@ -19,8 +22,13 @@ BuildRequires: imagemagick-devel BuildRequires: mesaglut-devel BuildRequires: mesagl-devel BuildRequires: vtk-devel -BuildRequires: gdcm-devel +%if %with scribo BuildRequires: tesseract-devel >= 2.04-3 +%endif +BuildRequires: imagemagick +BuildRequires: texlive-latex texlive-dvips +BuildRequires: latex2html +BuildRequires: doxygen %description Olena is a platform dedicated to image processing. At the @@ -46,7 +54,6 @@ its genericity: it allows to write an algorithm once and run it over many kinds of images (grey scale, color, 1D, 2D, 3D, ...). %files doc -%defattr(-,root,root,-) %_docdir/olena %endif @@ -65,9 +72,11 @@ its genericity: it allows to write an algorithm once and run it over many kinds of images (grey scale, color, 1D, 2D, 3D, ...). %files tools -%defattr(-,root,root,-) %_bindir/* -%_datadir/olena/images +%_datadir/olena +%if %with scribo +%_libdir/scribo/* +%endif #------------------------------------------------------------------------------ @@ -97,7 +106,6 @@ Group: Development/C++ trimesh C++ main Olena library. %files -n %{libtrimesh} -%defattr(-,root,root,-) %{_libdir}/libtrimesh.so.%{tri_major}* #------------------------------------------------------------------------------ @@ -118,44 +126,81 @@ its genericity: it allows to write an algorithm once and run it over many kinds of images (grey scale, color, 1D, 2D, 3D, ...). %files devel -%defattr(-,root,root,-) %{_libdir}/*.so %{_libdir}/*.la %{_includedir}/* -%exclude %_libdir/*.a +%_libdir/*.a #------------------------------------------------------------------------------ %prep %setup -q +%patch1 -p0 +%patch2 %if ! %with doc %patch0 -p0 -b .orig +autoreconf -fi %endif +pushd external/trimesh +autoreconf -fi +popd %build -CXXFLAGS="$CXXFLAGS -I%{_includedir}/ImageMagick" -export CPPFLAGS CXXFLAGS - %configure2_5x \ +%if %with scribo --enable-scribo \ +%endif --enable-trimesh \ %if %with apps --enable-apps \ %endif --enable-tools +pushd external/trimesh +%configure2_5x +popd + %make %install -rm -rf %{buildroot} %makeinstall_std -%clean -rm -rf %buildroot - %changelog +* Thu Dec 01 2011 Dmitry Mikhirev <dmikhirev(a)mandriva.org> 2:2.0-3 ++ Revision: 735945 +- Fixed compatibility to tesseract 3.01 + +* Wed Nov 09 2011 Andrey Smirnov <asmirnov(a)mandriva.org> 2:2.0-2 ++ Revision: 729310 +- Disable scribo until compatibility with current tesseract fixed + +* Wed Oct 05 2011 Nicolas LÃ©cureuil <nlecureuil(a)mandriva.com> 2:2.0-1 ++ Revision: 703157 +- Fix file list +- Install .a files +- Clean spec file +- New version 2.0 + + + Oden Eriksson <oeriksson(a)mandriva.com> + - rebuild + + + Pascal Terjan <pterjan(a)mandriva.org> + - Drop require on gdcm-devel for now : + - It is in contribs + - It is unused now (configure does not find it) + +* Sat May 08 2010 Funda Wang <fwang(a)mandriva.org> 2:1.0-6mdv2010.1 ++ Revision: 543630 +- fix link +- more BRs +- add BR +- add convert BR + + + Oden Eriksson <oeriksson(a)mandriva.com> + - rebuilt for 2010.1 + * Wed Sep 23 2009 Helio Chissini de Castro <helio(a)mandriva.com> 2:1.0-4mdv2010.0 + Revision: 448013 - Respect description, as requested in Mandriva bug #53959 @@ -177,5 +222,5 @@ rm -rf %buildroot + Revision: 421273 - imported package olena - + Nicolas LÃ©cureuil <neoclust(a)mandriva.org> - - import olena \ No newline at end of file + + Nicolas LÃ©cureuil <nlecureuil(a)mandriva.com> + - import olena -- 1.7.2.5

1 0

branch exp/rpm-packages created: olena-2.0-64-g669afb2
by git＠lrde.epita.fr 10 Apr '13

10 Apr '13

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Olena, a generic and efficient image processing platform". The branch exp/rpm-packages has been created at 669afb2e042fb5175b7ee83c5d29908c3cb9ddf1 (commit) - Log ----------------------------------------------------------------- 669afb2 distrib/rpm/olena.spec: New. ----------------------------------------------------------------------- hooks/post-receive -- Olena, a generic and efficient image processing platform

1 0