[Olena-patches] olena: olena-2.0-599-gc55a823 mln/core/var.hh: Document mln_VAR().

--- milena/ChangeLog | 4 ++++ milena/mln/core/var.hh | 26 ++++++++++++++++++++++---- 2 files changed, 26 insertions(+), 4 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index b868951..20eef46 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,9 @@ 2013-04-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + * mln/core/var.hh: Document mln_VAR(). + +2013-04-30 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; + Fix missing parts of mln::box interface in documentation. * doc/mln/core/alias/box1d.dox, diff --git a/milena/mln/core/var.hh b/milena/mln/core/var.hh index 9892815..41e6fcd 100644 --- a/milena/mln/core/var.hh +++ b/milena/mln/core/var.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. // @@ -35,14 +36,31 @@ # include <mln/core/macros.hh> -/// Definition of the macro mln_VAR. -/// Deduce the type of Expr, create a variable of that type and assign the -/// result to it. +/*! + \def mln_VAR(Var, Expr) + \brief Deduce the type of Expr, create a variable of that type and + assign the result to it. + + \warning Theses macro rely on an extension of g++ (\c typeof) so it + is NOT standard C++. + + \ingroup mlnmacros +*/ #define mln_VAR(Var, Expr) \ \ typeof(Expr) Var = Expr; \ typedef typeof(Expr) Var##_t +/*! + \def mln_const VAR(Var, Expr) + \brief Deduce the type of Expr, create a const variable of that type + and assign the result to it. + + \warning Theses macro rely on an extension of g++ (\c typeof) so it + is NOT standard C++. + + \ingroup mlnmacros +*/ #define mln_const_VAR(Var, Expr) \ \ const typeof(Expr) Var = Expr; \ -- 1.7.2.5