[Olena-patches] olena-2.0-473-g6750f67 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. --- 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 &lt;z(a)lrde.epita.fr&gt; + 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 &lt;z(a)lrde.epita.fr&gt; + 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