|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r69343 - in trunk/libs/geometry/doc: . doxy generated other ref reference/algorithms
From: barend.gehrels_at_[hidden]
Date: 2011-02-27 13:20:36
Author: barendgehrels
Date: 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
New Revision: 69343
URL: http://svn.boost.org/trac/boost/changeset/69343
Log:
Doc update
Added:
trunk/libs/geometry/doc/other/status.xls (contents, props changed)
trunk/libs/geometry/doc/reference/algorithms/overlay_behavior.qbk (contents, props changed)
Removed:
trunk/libs/geometry/doc/ref/
Text files modified:
trunk/libs/geometry/doc/Jamfile.v2 | 2 +-
trunk/libs/geometry/doc/doxy/Doxyfile | 1 +
trunk/libs/geometry/doc/generated/append.qbk | 2 +-
trunk/libs/geometry/doc/generated/area.qbk | 4 ++--
trunk/libs/geometry/doc/generated/buffer.qbk | 2 +-
trunk/libs/geometry/doc/generated/centroid.qbk | 8 ++++----
trunk/libs/geometry/doc/generated/difference.qbk | 9 ++++-----
trunk/libs/geometry/doc/generated/get.qbk | 4 ++--
trunk/libs/geometry/doc/generated/intersection.qbk | 6 +++---
trunk/libs/geometry/doc/generated/intersects.qbk | 4 ++--
trunk/libs/geometry/doc/generated/length.qbk | 4 ++--
trunk/libs/geometry/doc/generated/num_geometries.qbk | 2 +-
trunk/libs/geometry/doc/generated/num_interior_rings.qbk | 2 +-
trunk/libs/geometry/doc/generated/num_points.qbk | 2 +-
trunk/libs/geometry/doc/generated/perimeter.qbk | 4 ++--
trunk/libs/geometry/doc/generated/point.qbk | 2 +-
trunk/libs/geometry/doc/generated/register.qbk | 2 +-
trunk/libs/geometry/doc/generated/set.qbk | 4 ++--
trunk/libs/geometry/doc/generated/simplify.qbk | 6 +++---
trunk/libs/geometry/doc/generated/sym_difference.qbk | 4 ++--
trunk/libs/geometry/doc/generated/union.qbk | 2 +-
trunk/libs/geometry/doc/reference.qbk | 1 -
22 files changed, 38 insertions(+), 39 deletions(-)
Modified: trunk/libs/geometry/doc/Jamfile.v2
==============================================================================
--- trunk/libs/geometry/doc/Jamfile.v2 (original)
+++ trunk/libs/geometry/doc/Jamfile.v2 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -17,7 +17,7 @@
: geometry.qbk
: <dependency>Jamfile.v2
<dependency>quickref.xml
- <dependency>reference/point.qbk
+ <dependency>generated/point.qbk
: <xsl:param>chunk.section.depth=4
<xsl:param>chunk.first.sections=1
<xsl:param>toc.section.depth=3
Modified: trunk/libs/geometry/doc/doxy/Doxyfile
==============================================================================
--- trunk/libs/geometry/doc/doxy/Doxyfile (original)
+++ trunk/libs/geometry/doc/doxy/Doxyfile 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -58,6 +58,7 @@
tparam_dimension_required="Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry" \
tparam_first_point="first point type" \
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_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." \
Modified: trunk/libs/geometry/doc/generated/append.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/append.qbk (original)
+++ trunk/libs/geometry/doc/generated/append.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -41,7 +41,7 @@
`#include <boost/geometry/algorithms/append.hpp>`
-[include ref/algorithms/append.qbk]
+[include reference/algorithms/append.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/area.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/area.qbk (original)
+++ trunk/libs/geometry/doc/generated/area.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -45,7 +45,7 @@
`#include <boost/geometry/algorithms/area.hpp>`
-[include ref/algorithms/area.qbk]
+[include reference/algorithms/area.qbk]
[heading Example]
[area_with_strategy]
@@ -93,7 +93,7 @@
`#include <boost/geometry/algorithms/area.hpp>`
-[include ref/algorithms/area.qbk]
+[include reference/algorithms/area.qbk]
[heading Examples]
[area] [area_output]
Modified: trunk/libs/geometry/doc/generated/buffer.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/buffer.qbk (original)
+++ trunk/libs/geometry/doc/generated/buffer.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -44,7 +44,7 @@
`#include <boost/geometry/algorithms/buffer.hpp>`
-[include ref/algorithms/buffer.qbk]
+[include reference/algorithms/buffer.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/centroid.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/centroid.qbk (original)
+++ trunk/libs/geometry/doc/generated/centroid.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -42,7 +42,7 @@
`#include <boost/geometry/algorithms/centroid.hpp>`
-[include ref/algorithms/centroid.qbk]
+[include reference/algorithms/centroid.qbk]
[endsect]
@@ -77,7 +77,7 @@
`#include <boost/geometry/algorithms/centroid.hpp>`
-[include ref/algorithms/centroid.qbk]
+[include reference/algorithms/centroid.qbk]
[heading Available Strategies]
* [link geometry.reference.strategies.strategy_centroid_bashein_detmer Bashein Detmer (cartesian)]
@@ -117,7 +117,7 @@
`#include <boost/geometry/algorithms/centroid.hpp>`
-[include ref/algorithms/centroid.qbk]
+[include reference/algorithms/centroid.qbk]
[heading Available Strategies]
* [link geometry.reference.strategies.strategy_centroid_bashein_detmer Bashein Detmer (cartesian)]
@@ -145,7 +145,7 @@
[heading Returns]
-The calculated centroid [include ref/algorithms/centroid.qbk]
+The calculated centroid [include reference/algorithms/centroid.qbk]
[heading Header]
Either
Modified: trunk/libs/geometry/doc/generated/difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/difference.qbk (original)
+++ trunk/libs/geometry/doc/generated/difference.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -45,7 +45,7 @@
`#include <boost/geometry/algorithms/difference.hpp>`
-[include ref/algorithms/difference.qbk]
+[include reference/algorithms/difference.qbk]
[endsect]
@@ -57,7 +57,7 @@
[heading Description]
Calculate the difference of two geometries
-The free function difference\u005finserter calculates the spatial set theoretic difference of two geometries. details\u005finserter{difference}
+The free function difference\u005finserter calculates the spatial set theoretic difference of two geometries. This version with the \u005finserter suffix outputs the difference to an output iterator, and a template parameter must therefore be specified in the call.
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
@@ -86,8 +86,7 @@
`#include <boost/geometry/algorithms/difference.hpp>`
-[heading Example]
-[difference_inserter] [difference_inserter_output]
+[include reference/algorithms/difference_inserter.qbk]
[endsect]
@@ -99,7 +98,7 @@
[heading Description]
Calculate the difference of two geometries using the specified strategy
-The free function difference\u005finserter calculates the spatial set theoretic difference of two geometries using the specified strategy. details\u005finserter{difference}
+The free function difference\u005finserter calculates the spatial set theoretic difference of two geometries using the specified strategy. This version with the \u005finserter suffix outputs the difference to an output iterator, and a template parameter must therefore be specified in the call.
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
Modified: trunk/libs/geometry/doc/generated/get.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/get.qbk (original)
+++ trunk/libs/geometry/doc/generated/get.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -46,7 +46,7 @@
`#include <boost/geometry/core/access.hpp>`
-[include ref/core/get_box.qbk]
+[include reference/core/get_box.qbk]
[endsect]
@@ -72,7 +72,7 @@
[heading Returns]
-The coordinate value of specified dimension of specified geometry [include ref/core/get_point.qbk]
+The coordinate value of specified dimension of specified geometry [include reference/core/get_point.qbk]
[heading Header]
Either
Modified: trunk/libs/geometry/doc/generated/intersection.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/intersection.qbk (original)
+++ trunk/libs/geometry/doc/generated/intersection.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -43,7 +43,7 @@
`#include <boost/geometry/algorithms/intersection.hpp>`
-[include ref/algorithms/intersection.qbk]
+[include reference/algorithms/intersection.qbk]
[endsect]
@@ -76,7 +76,7 @@
[heading Header]
`#include <boost/geometry/algorithms/intersection_inserter.hpp>`
-[include ref/algorithms/intersection.qbk]
+[include reference/algorithms/intersection.qbk]
[endsect]
@@ -110,7 +110,7 @@
[heading Header]
`#include <boost/geometry/algorithms/intersection_inserter.hpp>`
-[include ref/algorithms/intersection.qbk]
+[include reference/algorithms/intersection.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/intersects.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/intersects.qbk (original)
+++ trunk/libs/geometry/doc/generated/intersects.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -42,7 +42,7 @@
`#include <boost/geometry/algorithms/intersects.hpp>`
-[include ref/algorithms/intersects.qbk]
+[include reference/algorithms/intersects.qbk]
[endsect]
@@ -75,7 +75,7 @@
`#include <boost/geometry/algorithms/intersects.hpp>`
-[include ref/algorithms/intersects.qbk]
+[include reference/algorithms/intersects.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/length.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/length.qbk (original)
+++ trunk/libs/geometry/doc/generated/length.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -45,7 +45,7 @@
`#include <boost/geometry/algorithms/length.hpp>`
-[include ref/algorithms/length.qbk]
+[include reference/algorithms/length.qbk]
[length_with_strategy] [length_with_strategy_output]
@@ -82,7 +82,7 @@
`#include <boost/geometry/algorithms/length.hpp>`
-[include ref/algorithms/length.qbk]
+[include reference/algorithms/length.qbk]
[length] [length_output]
Modified: trunk/libs/geometry/doc/generated/num_geometries.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/num_geometries.qbk (original)
+++ trunk/libs/geometry/doc/generated/num_geometries.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -44,7 +44,7 @@
`#include <boost/geometry/algorithms/num_geometries.hpp>`
-[include ref/algorithms/num_geometries.qbk]
+[include reference/algorithms/num_geometries.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/num_interior_rings.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/num_interior_rings.qbk (original)
+++ trunk/libs/geometry/doc/generated/num_interior_rings.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -44,7 +44,7 @@
`#include <boost/geometry/algorithms/num_interior_rings.hpp>`
-[include ref/algorithms/num_interior_rings.qbk]
+[include reference/algorithms/num_interior_rings.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/num_points.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/num_points.qbk (original)
+++ trunk/libs/geometry/doc/generated/num_points.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -45,7 +45,7 @@
`#include <boost/geometry/algorithms/num_points.hpp>`
-[include ref/algorithms/num_points.qbk]
+[include reference/algorithms/num_points.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/perimeter.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/perimeter.qbk (original)
+++ trunk/libs/geometry/doc/generated/perimeter.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -45,7 +45,7 @@
`#include <boost/geometry/algorithms/perimeter.hpp>`
-[include ref/algorithms/perimeter.qbk]
+[include reference/algorithms/perimeter.qbk]
[endsect]
@@ -81,7 +81,7 @@
`#include <boost/geometry/algorithms/perimeter.hpp>`
-[include ref/algorithms/perimeter.qbk]
+[include reference/algorithms/perimeter.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/point.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/point.qbk (original)
+++ trunk/libs/geometry/doc/generated/point.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -95,7 +95,7 @@
`#include <boost/geometry/geometries/point.hpp>`
-[include ref/geometries/point.qbk]
+[include reference/geometries/point.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/register.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/register.qbk (original)
+++ trunk/libs/geometry/doc/generated/register.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -38,7 +38,7 @@
[heading Header]
`#include <boost/geometry/geometries/register/point.hpp>`
-[include ref/geometries/register/point.qbk]
+[include reference/geometries/register/point.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/set.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/set.qbk (original)
+++ trunk/libs/geometry/doc/generated/set.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -44,7 +44,7 @@
`#include <boost/geometry/core/access.hpp>`
-[include ref/core/set_box.qbk]
+[include reference/core/set_box.qbk]
[endsect]
@@ -79,7 +79,7 @@
`#include <boost/geometry/core/access.hpp>`
-[include ref/core/set_point.qbk]
+[include reference/core/set_point.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/simplify.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/simplify.qbk (original)
+++ trunk/libs/geometry/doc/generated/simplify.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -40,7 +40,7 @@
`#include <boost/geometry/algorithms/simplify.hpp>`
-[include ref/algorithms/simplify.qbk]
+[include reference/algorithms/simplify.qbk]
[endsect]
@@ -103,7 +103,7 @@
`#include <boost/geometry/algorithms/simplify.hpp>`
-[include ref/algorithms/simplify_inserter.qbk]
+[include reference/algorithms/simplify_inserter.qbk]
[endsect]
@@ -136,7 +136,7 @@
`#include <boost/geometry/algorithms/simplify.hpp>`
-[include ref/algorithms/simplify.qbk]
+[include reference/algorithms/simplify.qbk]
[endsect]
Modified: trunk/libs/geometry/doc/generated/sym_difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/sym_difference.qbk (original)
+++ trunk/libs/geometry/doc/generated/sym_difference.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -43,7 +43,7 @@
`#include <boost/geometry/algorithms/sym_difference.hpp>`
-[include ref/algorithms/sym_difference.qbk]
+[include reference/algorithms/sym_difference.qbk]
[endsect]
@@ -90,7 +90,7 @@
Calculate the symmetric difference of two geometries using the specified strategy.
[heading Description]
-The free function symmetric difference calculates the spatial set theoretic symmetric difference (XOR) of two geometries using the specified strategy. details\u005finserter{sym\u005fdifference}
+The free function symmetric difference calculates the spatial set theoretic symmetric difference (XOR) of two geometries using the specified strategy. This version with the \u005finserter suffix outputs the sym\u005fdifference to an output iterator, and a template parameter must therefore be specified in the call.
[heading Synopsis]
``template<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>
Modified: trunk/libs/geometry/doc/generated/union.qbk
==============================================================================
--- trunk/libs/geometry/doc/generated/union.qbk (original)
+++ trunk/libs/geometry/doc/generated/union.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -43,7 +43,7 @@
`#include <boost/geometry/algorithms/union.hpp>`
-[include ref/algorithms/union.qbk]
+[include reference/algorithms/union.qbk]
[endsect]
Added: trunk/libs/geometry/doc/other/status.xls
==============================================================================
Binary file. No diff available.
Modified: trunk/libs/geometry/doc/reference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference.qbk (original)
+++ trunk/libs/geometry/doc/reference.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -203,7 +203,6 @@
[include generated/interior_type.qbk]
[include generated/is_areal.qbk]
[include generated/is_linear.qbk]
-[include generated/is_multi.qbk]
[include generated/is_radian.qbk]
[include generated/point_order.qbk]
[include generated/point_type.qbk]
Added: trunk/libs/geometry/doc/reference/algorithms/overlay_behavior.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/geometry/doc/reference/algorithms/overlay_behavior.qbk 2011-02-27 13:20:28 EST (Sun, 27 Feb 2011)
@@ -0,0 +1,19 @@
+[/============================================================================
+ Boost.Geometry (aka GGL, Generic Geometry Library)
+
+ Copyright (c) 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 Behavior]
+[table
+[[Case] [Behavior] ]
+[[__2dim__][All combinations of: box, ring, polygon, multi_polygon]]
+[[__other__][__nyiversion__]]
+[[__sph__][__nyiversion__]]
+[[Three dimensional][__nyiversion__]]
+]
+
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk