Subject: [Boost-commit] svn:boost r71837 - in trunk/libs/geometry/doc: . concept doxy reference/views
From: barend.gehrels_at_[hidden]
Date: 2011-05-08 16:59:39
Author: barendgehrels
Date: 2011-05-08 16:59:38 EDT (Sun, 08 May 2011)
New Revision: 71837
URL: http://svn.boost.org/trac/boost/changeset/71837
Log:
Doc update
Added:
trunk/libs/geometry/doc/reference/views/
trunk/libs/geometry/doc/reference/views/box_view.qbk (contents, props changed)
trunk/libs/geometry/doc/reference/views/segment_view.qbk (contents, props changed)
Text files modified:
trunk/libs/geometry/doc/concept/linestring.qbk | 5 ++---
trunk/libs/geometry/doc/doxy/Doxyfile | 2 +-
trunk/libs/geometry/doc/imports.qbk | 3 +++
3 files changed, 6 insertions(+), 4 deletions(-)
Modified: trunk/libs/geometry/doc/concept/linestring.qbk
==============================================================================
--- trunk/libs/geometry/doc/concept/linestring.qbk (original)
+++ trunk/libs/geometry/doc/concept/linestring.qbk 2011-05-08 16:59:38 EDT (Sun, 08 May 2011)
@@ -29,8 +29,7 @@
[heading Available Models]
* [link geometry.reference.models.model_linestring model::linestring]
-* a std::vector (requires `#include boost/geometry/geometries/adapted/std_as_linestring.hpp>`)
-* a std::deque (requires `#include boost/geometry/geometries/adapted/std_as_linestring.hpp>`)
-
+* a std::vector (requires registration)
+* a std::deque (requires registration)
[endsect]
Modified: trunk/libs/geometry/doc/doxy/Doxyfile
==============================================================================
--- trunk/libs/geometry/doc/doxy/Doxyfile (original)
+++ trunk/libs/geometry/doc/doxy/Doxyfile 2011-05-08 16:59:38 EDT (Sun, 08 May 2011)
@@ -61,7 +61,7 @@
tparam_functor="Function or class with operator()" \
tparam_output_collection="output collection, either a multi-geometry, or a std::vector<Geometry> / std::deque<Geometry> etc" \
tparam_geometry="Any type fulfilling a Geometry Concept" \
- tparam_geometry{1}="A type fulfilling a \1 Concept" \
+ tparam_geometry{1}="A type fulfilling the \1 Concept" \
tparam_index_required="Index, this template parameter is required. For a Box: either min_corner or max_corner. For a Segment: either 0 or 1 for first or last point." \
tparam_numeric="numerical type (int, double, ttmath, ...)" \
tparam_out{1}="A valid output iterator type, accepting geometries of \1 Concept" \
Modified: trunk/libs/geometry/doc/imports.qbk
==============================================================================
--- trunk/libs/geometry/doc/imports.qbk (original)
+++ trunk/libs/geometry/doc/imports.qbk 2011-05-08 16:59:38 EDT (Sun, 08 May 2011)
@@ -103,3 +103,6 @@
[import src/examples/geometries/register/multi_linestring.cpp]
[import src/examples/geometries/register/multi_polygon.cpp]
+
+[import src/examples/views/box_view.cpp]
+[import src/examples/views/segment_view.cpp]
Added: trunk/libs/geometry/doc/reference/views/box_view.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/views/box_view.qbk 2011-05-08 16:59:38 EDT (Sun, 08 May 2011)
@@ -0,0 +1,16 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2011 Barend Gehrels, Amsterdam, the Netherlands.
+
+ Use, modification and distribution is subject to the Boost Software License,
+ Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================/]
+
+[heading Complexity]
+Compile time
+
+[heading Example]
+[box_view]
+[box_view_output]
Added: trunk/libs/geometry/doc/reference/views/segment_view.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/views/segment_view.qbk 2011-05-08 16:59:38 EDT (Sun, 08 May 2011)
@@ -0,0 +1,16 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 2009-2011 Barend Gehrels, Amsterdam, the Netherlands.
+
+ Use, modification and distribution is subject to the Boost Software License,
+ Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================/]
+
+[heading Complexity]
+Compile time
+
+[heading Example]
+[segment_view]
+[segment_view_output]