[Boost-commit] svn:boost r71836 - trunk/boost/geometry/views

Subject: [Boost-commit] svn:boost r71836 - trunk/boost/geometry/views
From: barend.gehrels_at_[hidden]
Date: 2011-05-08 16:58:46

Author: barendgehrels
Date: 2011-05-08 16:58:46 EDT (Sun, 08 May 2011)
New Revision: 71836
URL: http://svn.boost.org/trac/boost/changeset/71836

Log:
Doc update
Text files modified: 
   trunk/boost/geometry/views/box_view.hpp       |    16 ++++++++++++++--                        
   trunk/boost/geometry/views/closeable_view.hpp |    14 ++++++++++----                          
   trunk/boost/geometry/views/segment_view.hpp   |    15 +++++++++++++--                         
   3 files changed, 37 insertions(+), 8 deletions(-)

Modified: trunk/boost/geometry/views/box_view.hpp
==============================================================================
--- trunk/boost/geometry/views/box_view.hpp	(original)
+++ trunk/boost/geometry/views/box_view.hpp	2011-05-08 16:58:46 EDT (Sun, 08 May 2011)
@@ -27,9 +27,20 @@
 
 
 /*!
-\brief Range, walking over the four points of a box
-\tparam Box box type
+\brief Makes a box behave like a ring or a range
+\details Adapts a box to the Boost.Range concept, enabling the user to iterating
+    box corners. The box_view is registered as a Ring Concept
+\tparam Box \tparam_geometry{Box}
+\tparam Clockwise If true, walks in clockwise direction, otherwise
+    it walks in counterclockwise direction
 \ingroup views
+
+\qbk{before.synopsis,
+[heading Model of]
+[link geometry.reference.concepts.concept_ring Ring Concept]
+}
+
+\qbk{[include reference/views/box_view.qbk]}
 */
 template <typename Box, bool Clockwise = true>
 struct box_view 
@@ -41,6 +52,7 @@
 {
     typedef typename geometry::point_type<Box>::type point_type;
     
+    /// Constructor accepting the box to adapt
     explicit box_view(Box const& box)
         : detail::points_view<point_type, 5>(copy_policy(box))
     {}

Modified: trunk/boost/geometry/views/closeable_view.hpp
==============================================================================
--- trunk/boost/geometry/views/closeable_view.hpp	(original)
+++ trunk/boost/geometry/views/closeable_view.hpp	2011-05-08 16:58:46 EDT (Sun, 08 May 2011)
@@ -41,7 +41,6 @@
         : m_range(r)
     {}
 
-
     typedef closing_iterator<Range> iterator;
     typedef closing_iterator<Range const> const_iterator;
 
@@ -60,9 +59,16 @@
 
 
 /*!
-\brief View on a range, either closing or not closing
-\tparam Range original range
-\tparam Close specifying if it should be closed or not
+\brief View on a range, either closing it or leaving it as it is
+\details The closeable_view is used internally by the library to handle all rings,
+    either closed or open, the same way. The default method is closed, all 
+    algorithms process rings as if they are closed. Therefore, if they are opened,
+    a view is created which closes them.
+    The closeable_view might be used by library users, but its main purpose is
+    internally.
+\tparam Range Original range
+\tparam Close Specifies if it the range is closed, if so, nothing will happen.
+    If it is open, it will iterate the first point after the last point.
 \ingroup views
 */
 template <typename Range, closure_selector Close>

Modified: trunk/boost/geometry/views/segment_view.hpp
==============================================================================
--- trunk/boost/geometry/views/segment_view.hpp	(original)
+++ trunk/boost/geometry/views/segment_view.hpp	2011-05-08 16:58:46 EDT (Sun, 08 May 2011)
@@ -27,9 +27,19 @@
 
 
 /*!
-\brief Range, walking over the two points of a segment
-\tparam Segment segment type
+\brief Makes a segment behave like a linestring or a range
+\details Adapts a segment to the Boost.Range concept, enabling the user to 
+    iterate the two segment points. The segment_view is registered as a LineString Concept
+\tparam Segment \tparam_geometry{Segment}
 \ingroup views
+
+\qbk{before.synopsis,
+[heading Model of]
+[link geometry.reference.concepts.concept_linestring LineString Concept]
+}
+
+\qbk{[include reference/views/segment_view.qbk]}
+
 */
 template <typename Segment>
 struct segment_view
@@ -41,6 +51,7 @@
 {
     typedef typename geometry::point_type<Segment>::type point_type;
     
+    /// Constructor accepting the segment to adapt
     explicit segment_view(Segment const& segment)
         : detail::points_view<point_type, 2>(copy_policy(segment))
     {}