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

Subject: [Boost-commit] svn:boost r65212 - sandbox/geometry/boost/geometry/core
From: barend.gehrels_at_[hidden]
Date: 2010-09-03 06:23:22

Author: barendgehrels
Date: 2010-09-03 06:23:21 EDT (Fri, 03 Sep 2010)
New Revision: 65212
URL: http://svn.boost.org/trac/boost/changeset/65212

Log:
Update of Doxygen/qbk documentation
Text files modified: 
   sandbox/geometry/boost/geometry/core/interior_rings.hpp |    24 +++++++++++++++---------                
   sandbox/geometry/boost/geometry/core/num_geometries.hpp |    17 +++++++++++------                       
   2 files changed, 26 insertions(+), 15 deletions(-)

Modified: sandbox/geometry/boost/geometry/core/interior_rings.hpp
==============================================================================
--- sandbox/geometry/boost/geometry/core/interior_rings.hpp	(original)
+++ sandbox/geometry/boost/geometry/core/interior_rings.hpp	2010-09-03 06:23:21 EDT (Fri, 03 Sep 2010)
@@ -212,15 +212,21 @@
 
 
 /*!
-    \brief Function to get the number of interior rings of a polygon
-    \ingroup access
-    \note Defined by OGC as "numInteriorRing". To be consistent with "numPoints"
-        letter "s" is appended
-    \note Can be used for any geometry, returning 0 for geometries not having
-        interior rings
-    \tparam Geometry geometry type
-    \param geometry the polygon or other geometry
-    \return the number of interior rings of the geometry
+\brief \brief_calc{number of interior rings}
+\ingroup num_interior_rings
+\details \details_calc{num_interior_rings, number of interior rings}.
+\tparam Geometry \tparam_geometry
+\param geometry \param_geometry
+\return \return_calc{number of interior rings}
+
+\qbk{behavior,__polygon__:[qbk_ret number of its interior rings]}
+\qbk{behavior,__multi_polygon__:[qbk_ret number of the interior rings of all polygons]}
+\qbk{behavior,__other__:[qbk_ret 0]}
+\qbk{compliance,__ogc__: numInteriorRing}
+\qbk{complexity,Constant}
+
+\note Defined by OGC as "numInteriorRing". To be consistent with "numPoints"
+    letter "s" is appended
 */
 template <typename Geometry>
 inline std::size_t num_interior_rings(Geometry const& geometry)

Modified: sandbox/geometry/boost/geometry/core/num_geometries.hpp
==============================================================================
--- sandbox/geometry/boost/geometry/core/num_geometries.hpp	(original)
+++ sandbox/geometry/boost/geometry/core/num_geometries.hpp	2010-09-03 06:23:21 EDT (Fri, 03 Sep 2010)
@@ -43,12 +43,17 @@
 
 
 /*!
-    \brief Function to get the number of geometries of a composite geometry.
-        For a single geometry it is always 0 (also for a polygon with holes)
-    \ingroup access
-    \tparam Geometry geometry type
-    \param geometry the polygon or other geometry
-    \return the number of interior rings of the geometry
+\brief \brief_calc{number of geometries}
+\ingroup num_geometries
+\details \details_calc{num_geometries, number of geometries}.
+\tparam Geometry \tparam_geometry
+\param geometry \param_geometry
+\return \return_calc{number of geometries}
+
+\qbk{behavior,__single__:[qbk_ret 1]}
+\qbk{behavior,__multi__:Returns boost::size(geometry); the input is considered as a range}
+\qbk{compliance,__ogc__}
+\qbk{complexity,Constant}
 */
 template <typename Geometry>
 inline std::size_t num_geometries(Geometry const& geometry)