[Boost-commit] svn:boost r60332 - sandbox/geometry/boost/geometry/core

Subject: [Boost-commit] svn:boost r60332 - sandbox/geometry/boost/geometry/core
From: mateusz_at_[hidden]
Date: 2010-03-07 17:58:07

Author: mloskot
Date: 2010-03-07 17:58:07 EST (Sun, 07 Mar 2010)
New Revision: 60332
URL: http://svn.boost.org/trac/boost/changeset/60332

Log:
Geometry: moved Index template parameter comments next to the right versions of get/set accessors. Use tripple /// for testing with new reference.{doxygen|.xsl} generator.
Text files modified: 
   sandbox/geometry/boost/geometry/core/access.hpp |    68 ++++++++++++++++++--------------------- 
   1 files changed, 32 insertions(+), 36 deletions(-)

Modified: sandbox/geometry/boost/geometry/core/access.hpp
==============================================================================
--- sandbox/geometry/boost/geometry/core/access.hpp	(original)
+++ sandbox/geometry/boost/geometry/core/access.hpp	2010-03-07 17:58:07 EST (Sun, 07 Mar 2010)
@@ -244,19 +244,12 @@
 
 // Note the comments below tell Doxygen to create one function with doc for both
 
-/*!
-\brief
-- get coordinate value of a Point ( / Sphere)
-\ingroup access
-\return coordinate value
-\tparam Index index
-- for Point: don't specify
-- for Box: min_corner or max_corner
-- for Segment: 0 / 1
-\tparam Dimension dimension
-\tparam Geometry geometry
-\param geometry geometry to get coordinate value from
-*/
+/// @brief get coordinate value of a Point ( / Sphere)
+/// @ingroup access
+/// @tparam Dimension dimension
+/// @tparam Geometry geometry
+/// @param geometry geometry to query coordinate value from
+/// @return coordinate value
 template <std::size_t Dimension, typename Geometry>
 inline typename coordinate_type<Geometry>::type get(Geometry const& geometry
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
@@ -280,19 +273,12 @@
 }
 
 
-/*!
-\brief
-- set coordinate value of a Point ( / Sphere)
-\ingroup access
-\tparam Index index
-- for Point: don't specify
-- for Box: min_corner or max_corner
-- for Segment: 0 / 1
-\tparam Dimension dimension
-\tparam Geometry geometry
-\param geometry geometry to assign coordinate to
-\param value coordinate value to assign
-*/
+/// @brief set coordinate value of a Point ( / Sphere)
+/// @tparam Dimension dimension
+/// @tparam Geometry geometry
+/// @param geometry geometry to assign coordinate to
+/// @param value coordinate value to assign
+/// @ingroup access
 template <std::size_t Dimension, typename Geometry>
 inline void set(Geometry& geometry
         , typename coordinate_type<Geometry>::type const& value
@@ -318,11 +304,16 @@
 
 // Note: doxygen needs a construct to distinguish get/set (like the gcc compiler)
 
-/*!
-\brief
-- get coordinate value of a Box / Segment
-\ingroup access
-*/
+/// @brief get coordinate value of a Box / Segment
+/// @tparam Index 
+/// - for Point: do not specify
+/// - for Box: min_corner or max_corner
+/// - for Segment: 0 / 1
+/// @tparam Dimension dimension
+/// @tparam Geometry geometry
+/// @param geometry geometry to query coordinate value from
+/// @return coordinate value
+/// @ingroup access
 template <std::size_t Index, std::size_t Dimension, typename Geometry>
 inline typename coordinate_type<Geometry>::type get(Geometry const& geometry
 #ifndef DOXYGEN_SHOULD_SKIP_THIS
@@ -346,11 +337,16 @@
     return coord_access_type::get(geometry);
 }
 
-/*!
-\brief
-- set coordinate value of a Box / Segment
-\ingroup access
-*/
+/// @brief set coordinate value of a Box / Segment
+/// @tparam Index 
+/// - for Point: do not specify
+/// - for Box: min_corner or max_corner
+/// - for Segment: 0 / 1
+/// @tparam Dimension dimension
+/// @tparam Geometry geometry
+/// @param geometry geometry to assign coordinate to
+/// @param value coordinate value to assign
+/// @ingroup access
 template <std::size_t Index, std::size_t Dimension, typename Geometry>
 inline void set(Geometry& geometry
         , typename coordinate_type<Geometry>::type const& value