* mln/core/macros.hh,
* 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: Use \relatesalso instead of \relates.
---
milena/ChangeLog | 15 ++++++
milena/mln/core/macros.hh | 42 +++++++++++------
milena/mln/literal/black.hh | 7 +++-
milena/mln/literal/colors.hh | 98 ++++++++++++++++++++++++++++++++++------
milena/mln/literal/identity.hh | 4 +-
milena/mln/literal/max.hh | 3 +-
milena/mln/literal/min.hh | 4 +-
milena/mln/literal/one.hh | 6 ++-
milena/mln/literal/origin.hh | 4 +-
milena/mln/literal/white.hh | 7 +++-
milena/mln/literal/zero.hh | 9 +++-
11 files changed, 163 insertions(+), 36 deletions(-)
diff --git a/milena/ChangeLog b/milena/ChangeLog
index d65543d..6f05562 100644
--- a/milena/ChangeLog
+++ b/milena/ChangeLog
@@ -1,5 +1,20 @@
2013-05-14 Guillaume Lazzara <z(a)lrde.epita.fr>
+ Do not move classes/functions in their related sections.
+
+ * mln/core/macros.hh,
+ * 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: Use \relatesalso instead of \relates.
+
+2013-05-14 Guillaume Lazzara <z(a)lrde.epita.fr>
+
Add documentation about neighborhood and window iterators.
* doc/examples-outputs.mk,
diff --git a/milena/mln/core/macros.hh b/milena/mln/core/macros.hh
index 668d582..58b3cac 100644
--- a/milena/mln/core/macros.hh
+++ b/milena/mln/core/macros.hh
@@ -174,7 +174,8 @@
To be used in templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/*!
\def mln_bkd_qiter_(T)
@@ -186,7 +187,8 @@
To be used in non-templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/// Shortcuts to access the backward neighbor iterator type associated
/// to a window of type T.
@@ -223,7 +225,8 @@
To be used in templated functions only.
\ingroup macrosima
- \relates mln::Image mln::Site_Set
+ \relatesalso mln::Image
+ \relatesalso mln::Site_Set
*/
/*!
\def mln_box_(T)
@@ -231,7 +234,8 @@
To be used in non-templated functions only.
\ingroup macrosima
- \relates mln::Image mln::Site_Set
+ \relatesalso mln::Image
+ \relatesalso mln::Site_Set
*/
/// Shortcuts to access the box type associated to T.
/// \{
@@ -562,7 +566,8 @@
To be used in templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/*!
\def mln_fwd_qiter_(T)
@@ -574,7 +579,8 @@
To be used in non-templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/// Shortcuts to access the forward neighbor iterator type associated
/// to a window of site T.
@@ -972,7 +978,8 @@
To be used in templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/*!
\def mln_qiter_(T)
@@ -984,7 +991,8 @@
To be used in non-templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/// Shortcuts to access the default neighbor iterator type associated
/// to the window of type T.
@@ -1463,7 +1471,8 @@
To be used in templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/*!
\def mln_fwd_qixter_(T)
@@ -1473,7 +1482,8 @@
To be used in non-templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
# define mln_fwd_qixter(I, W) typename mln::trait::fwd_qixter< I, W >::ret
# define mln_fwd_qixter_(I, W) mln::trait::fwd_qixter< I, W >::ret
@@ -1486,7 +1496,8 @@
To be used in templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/*!
\def mln_bkd_qixter_(T)
@@ -1496,7 +1507,8 @@
To be used in non-templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
# define mln_bkd_qixter(I, W) typename mln::trait::bkd_qixter< I, W >::ret
# define mln_bkd_qixter_(I, W) mln::trait::bkd_qixter< I, W >::ret
@@ -1510,7 +1522,8 @@
To be used in templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
/*!
\def mln_qixter_(T)
@@ -1520,7 +1533,8 @@
To be used in non-templated functions only.
\ingroup macrositerwin
- \relates mln::Window mln::Weighted_Window
+ \relatesalso mln::Window
+ \relatesalso mln::Weighted_Window
*/
# define mln_qixter(I, W) mln_fwd_qixter(I, W)
# define mln_qixter_(I, W) mln_fwd_qixter_(I, W)
diff --git a/milena/mln/literal/black.hh b/milena/mln/literal/black.hh
index bd43d22..cf0ec85 100644
--- a/milena/mln/literal/black.hh
+++ b/milena/mln/literal/black.hh
@@ -55,7 +55,12 @@ namespace mln
/*!
\brief Literal black.
- \relates mln::literal::black_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::black_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso 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 70d8834..762340a 100644
--- a/milena/mln/literal/colors.hh
+++ b/milena/mln/literal/colors.hh
@@ -154,98 +154,168 @@ namespace mln
/*!
\brief Literal red.
- \relates mln::literal::red_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::red_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const red_t red;
/*!
\brief Literal green.
- \relates mln::literal::green_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::green_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const green_t green;
/*!
\brief Literal blue.
- \relates mln::literal::blue_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::blue_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const blue_t blue;
/*!
\brief Literal brown.
- \relates mln::literal::brown_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::brown_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const brown_t brown;
/*!
\brief Literal lime.
- \relates mln::literal::lime_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::lime_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const lime_t lime;
/*!
\brief Literal orange.
- \relates mln::literal::orange_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::orange_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const orange_t orange;
/*!
\brief Literal pink.
- \relates mln::literal::pink_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::pink_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const pink_t pink;
/*!
\brief Literal purple.
- \relates mln::literal::purple_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::purple_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const purple_t purple;
/*!
\brief Literal teal.
- \relates mln::literal::teal_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::teal_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const teal_t teal;
/*!
\brief Literal violet.
- \relates mln::literal::violet_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::violet_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const violet_t violet;
/*!
\brief Literal cyan.
- \relates mln::literal::cyan_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::cyan_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const cyan_t cyan;
/*!
\brief Literal magenta.
- \relates mln::literal::magenta_t mln::value::rgb mln::value::rgb8
mln::value::rgb16
+
+ \relatesalso mln::literal::magenta_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const magenta_t magenta;
/*!
\brief Literal yellow.
- \relates mln::literal::yellow_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::yellow_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const yellow_t yellow;
/*!
\brief Literal olive.
- \relates mln::literal::olive_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::olive_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso mln::value::rgb16
+
\ingroup literalcolors valuergb
*/
extern const olive_t olive;
diff --git a/milena/mln/literal/identity.hh b/milena/mln/literal/identity.hh
index 4ff840e..9876a88 100644
--- a/milena/mln/literal/identity.hh
+++ b/milena/mln/literal/identity.hh
@@ -51,7 +51,9 @@ namespace mln
/*!
\brief Literal identity.
\ingroup modliteral
- \relates mln::literal::identity_t mln::algebra::mat
+
+ \relatesalso mln::literal::identity_t
+ \relatesalso mln::algebra::mat
*/
extern const identity_t identity;
diff --git a/milena/mln/literal/max.hh b/milena/mln/literal/max.hh
index 0e3b7c9..bd474a7 100644
--- a/milena/mln/literal/max.hh
+++ b/milena/mln/literal/max.hh
@@ -56,7 +56,8 @@ namespace mln
/*!
\brief Literal max.
\ingroup modliteral
- \relates mln::literal::max_t
+
+ \relatesalso mln::literal::max_t
*/
extern const max_t max;
diff --git a/milena/mln/literal/min.hh b/milena/mln/literal/min.hh
index a5cfc40..59a2354 100644
--- a/milena/mln/literal/min.hh
+++ b/milena/mln/literal/min.hh
@@ -55,7 +55,9 @@ namespace mln
/*!
\brief Literal min.
- \relates mln::literal::min_t
+
+ \relatesalso 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 4f06663..910ac30 100644
--- a/milena/mln/literal/one.hh
+++ b/milena/mln/literal/one.hh
@@ -58,7 +58,11 @@ namespace mln
/*!
\brief Literal one.
\ingroup modliteral
- \relates mln::literal::one_t mln::value::int_s mln::value::int_u_sat
mln::value::sign
+
+ \relatesalso mln::literal::one_t
+ \relatesalso mln::value::int_s
+ \relatesalso mln::value::int_u_sat
+ \relatesalso mln::value::sign
*/
extern const one_t one;
diff --git a/milena/mln/literal/origin.hh b/milena/mln/literal/origin.hh
index a426510..7904f3b 100644
--- a/milena/mln/literal/origin.hh
+++ b/milena/mln/literal/origin.hh
@@ -52,7 +52,9 @@ namespace mln
/*!
\brief Literal origin.
\ingroup modliteral
- \relates mln::literal::origin_t mln::algebra::vec mln::point
+
+ \relatesalso mln::literal::origin_t
+ \relatesalso mln::algebra::vec mln::point
*/
extern const origin_t origin;
diff --git a/milena/mln/literal/white.hh b/milena/mln/literal/white.hh
index b578356..875a18c 100644
--- a/milena/mln/literal/white.hh
+++ b/milena/mln/literal/white.hh
@@ -55,7 +55,12 @@ namespace mln
/*!
\brief Literal white.
- \relates mln::literal::white_t mln::value::rgb mln::value::rgb8 mln::value::rgb16
+
+ \relatesalso mln::literal::white_t
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::rgb8
+ \relatesalso 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 40448ba..3929e66 100644
--- a/milena/mln/literal/zero.hh
+++ b/milena/mln/literal/zero.hh
@@ -58,7 +58,14 @@ namespace mln
/*!
\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
+
+ \relatesalso mln::literal::zero_t
+ \relatesalso mln::algebra::vec
+ \relatesalso mln::value::int_s
+ \relatesalso mln::value::int_u_sat
+ \relatesalso mln::value::qt::rgb32
+ \relatesalso mln::value::rgb
+ \relatesalso mln::value::sign
\ingroup modliteral
*/
--
1.7.2.5