[Olena-patches] olena: olena-2.0-850-g9abe047 Milena: Improve the documentation of mln::test::positive.

* mln/test/positive.hh: Here. --- milena/ChangeLog | 6 ++++++ milena/mln/test/positive.hh | 15 +++++++++++---- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 5280cb8..568fad9 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,11 @@ 2014-04-02 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Milena: Improve the documentation of mln::test::positive. + + * mln/test/positive.hh: Here. + +2014-04-02 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Milena: Simplify tests/pw/value.cc. * tests/pw/value.cc: Here. diff --git a/milena/mln/test/positive.hh b/milena/mln/test/positive.hh index 4b8a204..5a00043 100644 --- a/milena/mln/test/positive.hh +++ b/milena/mln/test/positive.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009, 2011 EPITA Research and Development -// Laboratory (LRDE) +// Copyright (C) 2007, 2008, 2009, 2011, 2014 EPITA Research and +// Development Laboratory (LRDE). // // This file is part of Olena. // @@ -29,7 +29,8 @@ /// \file /// -/// Test if an image only contains positive values. +/// Test if an image only contains positive or null +/// (i.e. ``non-negative'') values. # include <mln/test/predicate.hh> # include <mln/pw/all.hh> @@ -43,7 +44,13 @@ namespace mln namespace test { - /// Test if an image only contains positive values. + /// \brief Test if an image only contains positive or null + /// (i.e. ``non-negative'') values. + /// + /// This routine checks whether all the values of an image are + /// non-negative, thus considering includes 0 as a valid value + /// (which is usually not the case of the term ``positive'' in + /// English). template <typename I> bool positive(const Image<I>& input); -- 1.7.10.4