diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 index cd9929d4d..5ac6f4ca1 100644 --- a/doc/Jamfile.v2 +++ b/doc/Jamfile.v2 @@ -17,7 +17,7 @@ boostbook geometry : geometry.qbk : Jamfile.v2 quickref.xml - reference/point.qbk + generated/point.qbk : chunk.section.depth=4 chunk.first.sections=1 toc.section.depth=3 diff --git a/doc/doxy/Doxyfile b/doc/doxy/Doxyfile index 3bdde3002..857104a55 100644 --- a/doc/doxy/Doxyfile +++ b/doc/doxy/Doxyfile @@ -58,6 +58,7 @@ ALIASES = qbk{1}="\xmlonly \1 \endxmlonly" \ 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 / std::deque 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." \ diff --git a/doc/generated/append.qbk b/doc/generated/append.qbk index 627f7ca8a..6abd09d50 100644 --- a/doc/generated/append.qbk +++ b/doc/generated/append.qbk @@ -41,7 +41,7 @@ Or `#include ` -[include ref/algorithms/append.qbk] +[include reference/algorithms/append.qbk] [endsect] diff --git a/doc/generated/area.qbk b/doc/generated/area.qbk index 33b0b2e8a..feaa7a873 100644 --- a/doc/generated/area.qbk +++ b/doc/generated/area.qbk @@ -45,7 +45,7 @@ Or `#include ` -[include ref/algorithms/area.qbk] +[include reference/algorithms/area.qbk] [heading Example] [area_with_strategy] @@ -93,7 +93,7 @@ Or `#include ` -[include ref/algorithms/area.qbk] +[include reference/algorithms/area.qbk] [heading Examples] [area] [area_output] diff --git a/doc/generated/buffer.qbk b/doc/generated/buffer.qbk index b314e0fef..3a74d58b0 100644 --- a/doc/generated/buffer.qbk +++ b/doc/generated/buffer.qbk @@ -44,7 +44,7 @@ Or `#include ` -[include ref/algorithms/buffer.qbk] +[include reference/algorithms/buffer.qbk] [endsect] diff --git a/doc/generated/centroid.qbk b/doc/generated/centroid.qbk index 63dd52063..b26863a0b 100644 --- a/doc/generated/centroid.qbk +++ b/doc/generated/centroid.qbk @@ -42,7 +42,7 @@ Or `#include ` -[include ref/algorithms/centroid.qbk] +[include reference/algorithms/centroid.qbk] [endsect] @@ -77,7 +77,7 @@ Or `#include ` -[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 @@ Or `#include ` -[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 @@ Point make_centroid(Geometry const & geometry)`` [heading Returns] -The calculated centroid [include ref/algorithms/centroid.qbk] +The calculated centroid [include reference/algorithms/centroid.qbk] [heading Header] Either diff --git a/doc/generated/difference.qbk b/doc/generated/difference.qbk index 2a62cd311..c2ef9f70f 100644 --- a/doc/generated/difference.qbk +++ b/doc/generated/difference.qbk @@ -45,7 +45,7 @@ Or `#include ` -[include ref/algorithms/difference.qbk] +[include reference/algorithms/difference.qbk] [endsect] @@ -57,7 +57,7 @@ Or [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 @@ -86,8 +86,7 @@ Or `#include ` -[heading Example] -[difference_inserter] [difference_inserter_output] +[include reference/algorithms/difference_inserter.qbk] [endsect] @@ -99,7 +98,7 @@ Or [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 diff --git a/doc/generated/get.qbk b/doc/generated/get.qbk index eb9dd4c9a..125fef9a4 100644 --- a/doc/generated/get.qbk +++ b/doc/generated/get.qbk @@ -46,7 +46,7 @@ Or `#include ` -[include ref/core/get_box.qbk] +[include reference/core/get_box.qbk] [endsect] @@ -72,7 +72,7 @@ coordinate_type::type get(Geometry const & geometry)`` [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 diff --git a/doc/generated/intersection.qbk b/doc/generated/intersection.qbk index 2a43122dc..49164b398 100644 --- a/doc/generated/intersection.qbk +++ b/doc/generated/intersection.qbk @@ -43,7 +43,7 @@ Or `#include ` -[include ref/algorithms/intersection.qbk] +[include reference/algorithms/intersection.qbk] [endsect] @@ -76,7 +76,7 @@ The output iterator [heading Header] `#include ` -[include ref/algorithms/intersection.qbk] +[include reference/algorithms/intersection.qbk] [endsect] @@ -110,7 +110,7 @@ The output iterator [heading Header] `#include ` -[include ref/algorithms/intersection.qbk] +[include reference/algorithms/intersection.qbk] [endsect] diff --git a/doc/generated/intersects.qbk b/doc/generated/intersects.qbk index 24175beea..ea106e0d3 100644 --- a/doc/generated/intersects.qbk +++ b/doc/generated/intersects.qbk @@ -42,7 +42,7 @@ Or `#include ` -[include ref/algorithms/intersects.qbk] +[include reference/algorithms/intersects.qbk] [endsect] @@ -75,7 +75,7 @@ Or `#include ` -[include ref/algorithms/intersects.qbk] +[include reference/algorithms/intersects.qbk] [endsect] diff --git a/doc/generated/length.qbk b/doc/generated/length.qbk index 61f4c8556..526f72a20 100644 --- a/doc/generated/length.qbk +++ b/doc/generated/length.qbk @@ -45,7 +45,7 @@ Or `#include ` -[include ref/algorithms/length.qbk] +[include reference/algorithms/length.qbk] [length_with_strategy] [length_with_strategy_output] @@ -82,7 +82,7 @@ Or `#include ` -[include ref/algorithms/length.qbk] +[include reference/algorithms/length.qbk] [length] [length_output] diff --git a/doc/generated/num_geometries.qbk b/doc/generated/num_geometries.qbk index 747705e6f..e883b484f 100644 --- a/doc/generated/num_geometries.qbk +++ b/doc/generated/num_geometries.qbk @@ -44,7 +44,7 @@ Or `#include ` -[include ref/algorithms/num_geometries.qbk] +[include reference/algorithms/num_geometries.qbk] [endsect] diff --git a/doc/generated/num_interior_rings.qbk b/doc/generated/num_interior_rings.qbk index df21cb9b1..583870f25 100644 --- a/doc/generated/num_interior_rings.qbk +++ b/doc/generated/num_interior_rings.qbk @@ -44,7 +44,7 @@ Or `#include ` -[include ref/algorithms/num_interior_rings.qbk] +[include reference/algorithms/num_interior_rings.qbk] [endsect] diff --git a/doc/generated/num_points.qbk b/doc/generated/num_points.qbk index c616eb87e..ff40c9a40 100644 --- a/doc/generated/num_points.qbk +++ b/doc/generated/num_points.qbk @@ -45,7 +45,7 @@ Or `#include ` -[include ref/algorithms/num_points.qbk] +[include reference/algorithms/num_points.qbk] [endsect] diff --git a/doc/generated/perimeter.qbk b/doc/generated/perimeter.qbk index ee5d39438..2971de52d 100644 --- a/doc/generated/perimeter.qbk +++ b/doc/generated/perimeter.qbk @@ -45,7 +45,7 @@ Or `#include ` -[include ref/algorithms/perimeter.qbk] +[include reference/algorithms/perimeter.qbk] [endsect] @@ -81,7 +81,7 @@ Or `#include ` -[include ref/algorithms/perimeter.qbk] +[include reference/algorithms/perimeter.qbk] [endsect] diff --git a/doc/generated/point.qbk b/doc/generated/point.qbk index faf8e7461..6dfb7a610 100644 --- a/doc/generated/point.qbk +++ b/doc/generated/point.qbk @@ -95,7 +95,7 @@ Or `#include ` -[include ref/geometries/point.qbk] +[include reference/geometries/point.qbk] [endsect] diff --git a/doc/generated/register.qbk b/doc/generated/register.qbk index c64237789..e441fdbfc 100644 --- a/doc/generated/register.qbk +++ b/doc/generated/register.qbk @@ -38,7 +38,7 @@ The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D registers a two-d [heading Header] `#include ` -[include ref/geometries/register/point.qbk] +[include reference/geometries/register/point.qbk] [endsect] diff --git a/doc/generated/set.qbk b/doc/generated/set.qbk index dd85cc95c..b7c467947 100644 --- a/doc/generated/set.qbk +++ b/doc/generated/set.qbk @@ -44,7 +44,7 @@ Or `#include ` -[include ref/core/set_box.qbk] +[include reference/core/set_box.qbk] [endsect] @@ -79,7 +79,7 @@ Or `#include ` -[include ref/core/set_point.qbk] +[include reference/core/set_point.qbk] [endsect] diff --git a/doc/generated/simplify.qbk b/doc/generated/simplify.qbk index ab87dfe05..8c7bad907 100644 --- a/doc/generated/simplify.qbk +++ b/doc/generated/simplify.qbk @@ -40,7 +40,7 @@ Or `#include ` -[include ref/algorithms/simplify.qbk] +[include reference/algorithms/simplify.qbk] [endsect] @@ -103,7 +103,7 @@ Or `#include ` -[include ref/algorithms/simplify_inserter.qbk] +[include reference/algorithms/simplify_inserter.qbk] [endsect] @@ -136,7 +136,7 @@ Or `#include ` -[include ref/algorithms/simplify.qbk] +[include reference/algorithms/simplify.qbk] [endsect] diff --git a/doc/generated/sym_difference.qbk b/doc/generated/sym_difference.qbk index dc81ea172..d5cef63b7 100644 --- a/doc/generated/sym_difference.qbk +++ b/doc/generated/sym_difference.qbk @@ -43,7 +43,7 @@ Or `#include ` -[include ref/algorithms/sym_difference.qbk] +[include reference/algorithms/sym_difference.qbk] [endsect] @@ -90,7 +90,7 @@ Or 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 diff --git a/doc/generated/union.qbk b/doc/generated/union.qbk index 3d3ae1ea2..292c6993a 100644 --- a/doc/generated/union.qbk +++ b/doc/generated/union.qbk @@ -43,7 +43,7 @@ Or `#include ` -[include ref/algorithms/union.qbk] +[include reference/algorithms/union.qbk] [endsect] diff --git a/doc/other/status.xls b/doc/other/status.xls new file mode 100644 index 000000000..1a6ed5c1a Binary files /dev/null and b/doc/other/status.xls differ diff --git a/doc/reference.qbk b/doc/reference.qbk index 988f1ea88..399568703 100644 --- a/doc/reference.qbk +++ b/doc/reference.qbk @@ -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] diff --git a/doc/reference/algorithms/overlay_behavior.qbk b/doc/reference/algorithms/overlay_behavior.qbk new file mode 100644 index 000000000..ed6ca6fbc --- /dev/null +++ b/doc/reference/algorithms/overlay_behavior.qbk @@ -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__]] +] +