* doc/mln/literal/literal.dox: New. * mln/literal/black.hh, * mln/literal/colors.hh, * mln/literal/identity.hh, * mln/literal/max.hh, * mln/literal/min.hh, * mln/literal/one.hh, * mln/literal/origin.hh, * mln/literal/white.hh, * mln/literal/zero.hh: Move to literal module. --- milena/ChangeLog | 16 ++++++ milena/doc/mln/literal/literal.dox | 14 ++++++ milena/mln/literal/black.hh | 10 +++- milena/mln/literal/colors.hh | 89 +++++++++++++++++++++++++++++------ milena/mln/literal/identity.hh | 10 +++- milena/mln/literal/max.hh | 10 +++- milena/mln/literal/min.hh | 9 +++- milena/mln/literal/one.hh | 10 +++- milena/mln/literal/origin.hh | 10 +++- milena/mln/literal/white.hh | 8 ++- milena/mln/literal/zero.hh | 11 +++- 11 files changed, 159 insertions(+), 38 deletions(-) create mode 100644 milena/doc/mln/literal/literal.dox diff --git a/milena/ChangeLog b/milena/ChangeLog index 31a5976..a303bb5 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,21 @@ 2013-04-30 Guillaume Lazzara <z@lrde.epita.fr> + Add a module related to literals. + + * doc/mln/literal/literal.dox: New. + + * mln/literal/black.hh, + * mln/literal/colors.hh, + * mln/literal/identity.hh, + * mln/literal/max.hh, + * mln/literal/min.hh, + * mln/literal/one.hh, + * mln/literal/origin.hh, + * mln/literal/white.hh, + * mln/literal/zero.hh: Move to literal module. + +2013-04-30 Guillaume Lazzara <z@lrde.epita.fr> + Small fixes in existing documentation. * mln/data/convert.hh: Remove a duplicate \overload. diff --git a/milena/doc/mln/literal/literal.dox b/milena/doc/mln/literal/literal.dox new file mode 100644 index 0000000..9b8c8fc --- /dev/null +++ b/milena/doc/mln/literal/literal.dox @@ -0,0 +1,14 @@ +/*! \defgroup modliteral Literals + * + * \brief All the literal (generic) values. + * + * \ingroup modtypes + */ + + +/*! \defgroup literalcolors Predefined Colors + * + * \brief All the predefined literal (generic) colors. + * + * \ingroup modliteral + */ diff --git a/milena/mln/literal/black.hh b/milena/mln/literal/black.hh index 3b0bd2f..bd43d22 100644 --- a/milena/mln/literal/black.hh +++ b/milena/mln/literal/black.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -53,7 +53,11 @@ namespace mln }; - /// Literal black. + /*! + \brief Literal black. + \relates mln::literal::black_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const black_t black; diff --git a/milena/mln/literal/colors.hh b/milena/mln/literal/colors.hh index e70d843..70d8834 100644 --- a/milena/mln/literal/colors.hh +++ b/milena/mln/literal/colors.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -151,46 +151,103 @@ namespace mln olive_t(); }; - /// Literal red. + + /*! + \brief Literal red. + \relates mln::literal::red_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const red_t red; - /// Literal green. + /*! + \brief Literal green. + \relates mln::literal::green_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const green_t green; - /// Literal blue. + /*! + \brief Literal blue. + \relates mln::literal::blue_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const blue_t blue; - /// Literal brown. + /*! + \brief Literal brown. + \relates mln::literal::brown_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const brown_t brown; - /// Literal lime. + /*! + \brief Literal lime. + \relates mln::literal::lime_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const lime_t lime; - /// Literal orange. + /*! + \brief Literal orange. + \relates mln::literal::orange_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const orange_t orange; - /// Literal pink. + /*! + \brief Literal pink. + \relates mln::literal::pink_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const pink_t pink; - /// Literal purple. + /*! + \brief Literal purple. + \relates mln::literal::purple_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const purple_t purple; - /// Literal teal. + /*! + \brief Literal teal. + \relates mln::literal::teal_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const teal_t teal; - /// Literal violet. + /*! + \brief Literal violet. + \relates mln::literal::violet_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const violet_t violet; - /// Literal cyan. + /*! + \brief Literal cyan. + \relates mln::literal::cyan_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const cyan_t cyan; - /// Literal magenta. + /*! + \brief Literal magenta. + \relates mln::literal::magenta_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const magenta_t magenta; - /// Literal yellow. + /*! + \brief Literal yellow. + \relates mln::literal::yellow_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const yellow_t yellow; - /// Literal olive. + /*! + \brief Literal olive. + \relates mln::literal::olive_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const olive_t olive; # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/literal/identity.hh b/milena/mln/literal/identity.hh index 8e78aad..4ff840e 100644 --- a/milena/mln/literal/identity.hh +++ b/milena/mln/literal/identity.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. // @@ -48,7 +48,11 @@ namespace mln identity_t(); }; - /// Literal identity. + /*! + \brief Literal identity. + \ingroup modliteral + \relates mln::literal::identity_t mln::algebra::mat + */ extern const identity_t identity; # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/literal/max.hh b/milena/mln/literal/max.hh index 1085750..0e3b7c9 100644 --- a/milena/mln/literal/max.hh +++ b/milena/mln/literal/max.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. // @@ -53,7 +53,11 @@ namespace mln }; - /// Literal max. + /*! + \brief Literal max. + \ingroup modliteral + \relates mln::literal::max_t + */ extern const max_t max; diff --git a/milena/mln/literal/min.hh b/milena/mln/literal/min.hh index 3ac5014..a5cfc40 100644 --- a/milena/mln/literal/min.hh +++ b/milena/mln/literal/min.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. // @@ -52,7 +53,11 @@ namespace mln }; - /// Literal min. + /*! + \brief Literal min. + \relates mln::literal::min_t + \ingroup modliteral + */ extern const min_t min; diff --git a/milena/mln/literal/one.hh b/milena/mln/literal/one.hh index 310c6f6..4f06663 100644 --- a/milena/mln/literal/one.hh +++ b/milena/mln/literal/one.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -55,7 +55,11 @@ namespace mln }; - /// Literal one. + /*! + \brief Literal one. + \ingroup modliteral + \relates mln::literal::one_t mln::value::int_s mln::value::int_u_sat mln::value::sign + */ extern const one_t one; diff --git a/milena/mln/literal/origin.hh b/milena/mln/literal/origin.hh index 8c99669..a426510 100644 --- a/milena/mln/literal/origin.hh +++ b/milena/mln/literal/origin.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -49,7 +49,11 @@ namespace mln origin_t(); }; - /// Literal origin. + /*! + \brief Literal origin. + \ingroup modliteral + \relates mln::literal::origin_t mln::algebra::vec mln::point + */ extern const origin_t origin; # ifndef MLN_INCLUDE_ONLY diff --git a/milena/mln/literal/white.hh b/milena/mln/literal/white.hh index 7f7a80b..b578356 100644 --- a/milena/mln/literal/white.hh +++ b/milena/mln/literal/white.hh @@ -1,4 +1,4 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Copyright (C) 2007, 2008, 2009, 2013 EPITA Research and Development // Laboratory (LRDE) // // This file is part of Olena. @@ -53,7 +53,11 @@ namespace mln }; - /// Literal white. + /*! + \brief Literal white. + \relates mln::literal::white_t mln::value::rgb mln::value::rgb8 mln::value::rgb16 + \ingroup literalcolors valuergb + */ extern const white_t white; diff --git a/milena/mln/literal/zero.hh b/milena/mln/literal/zero.hh index 276cbb4..40448ba 100644 --- a/milena/mln/literal/zero.hh +++ b/milena/mln/literal/zero.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2013 EPITA Research and +// Development Laboratory (LRDE) // // This file is part of Olena. // @@ -56,7 +56,12 @@ namespace mln operator const T () const; }; - /// Literal zero. + /*! + \brief Literal zero. + \relates mln::literal::zero_t mln::algebra::vec mln::value::int_s mln::value::int_u_sat mln::value::qt::rgb32 mln::value::rgb mln::value::sign + + \ingroup modliteral + */ extern const zero_t zero; # ifndef MLN_INCLUDE_ONLY -- 1.7.2.5