[Olena-patches] [PATCH 2/2] Adjust the documentation of 2- and 3-dimensional point types.

* mln/core/alias/point2d.hh, mln/core/alias/point3d.hh: Here. --- milena/ChangeLog | 6 ++++++ milena/mln/core/alias/point2d.hh | 15 +++++++++------ milena/mln/core/alias/point3d.hh | 8 ++++---- 3 files changed, 19 insertions(+), 10 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index 1bea379..6c85c11 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,5 +1,11 @@ 2009-05-18 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Adjust the documentation of 2- and 3-dimensional point types. + + * mln/core/alias/point2d.hh, mln/core/alias/point3d.hh: Here. + +2009-05-18 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + Add a floating-point 1-dimensional point type. * mln/core/alias/point1d.hh (mln::point1df): New. diff --git a/milena/mln/core/alias/point2d.hh b/milena/mln/core/alias/point2d.hh index 898cf92..5bf7d9c 100644 --- a/milena/mln/core/alias/point2d.hh +++ b/milena/mln/core/alias/point2d.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -31,11 +31,12 @@ /// \file mln/core/alias/point2d.hh /// -/// Definition of the mln::point2d alias and of its construction -/// routine. +/// Definition of the mln::point2d and mln::point2df aliases and of +/// their construction routines. # include <mln/core/point.hh> -# include <mln/core/concept/site_proxy.hh> // For site_const_impl and site_mutable_impl. +// For site_const_impl and site_mutable_impl. +# include <mln/core/concept/site_proxy.hh> # include <mln/core/internal/force_exact.hh> @@ -44,8 +45,10 @@ namespace mln /// Type alias for a point defined on the 2D square grid with /// integer coordinates. - /// typedef point<mln::grid::square, mln::def::coord> point2d; + + /// Type alias for a point defined on the 2D square grid with + /// floating-point coordinates. typedef point<mln::grid::square, mln::def::coordf> point2df; diff --git a/milena/mln/core/alias/point3d.hh b/milena/mln/core/alias/point3d.hh index ceff9c1..81296c8 100644 --- a/milena/mln/core/alias/point3d.hh +++ b/milena/mln/core/alias/point3d.hh @@ -1,5 +1,5 @@ -// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory -// (LRDE) +// Copyright (C) 2007, 2008, 2009 EPITA Research and Development +// Laboratory (LRDE) // // This file is part of the Olena Library. This library is free // software; you can redistribute it and/or modify it under the terms @@ -31,8 +31,8 @@ /// \file mln/core/alias/point3d.hh /// -/// Definition of the mln::point3d alias and of its construction -/// routine. +/// Definition of the mln::point3d and mln::point3df aliases and of +/// their construction routines. # include <mln/core/point.hh> // For site_const_impl and site_mutable_impl: -- 1.6.2.4