boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-09 23:24:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc update

Browse Source 
[SVN r69343]
This commit is contained in:
Barend Gehrels 2011-02-27 18:20:28 +00:00
parent 86c175287c
commit eb0bc69f56
24 changed files with 57 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Jamfile.v2
View File

@ -17,7 +17,7 @@ boostbook geometry
: 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

1
doc/doxy/Doxyfile
View File

@ -58,6 +58,7 @@ ALIASES = qbk{1}="\xmlonly <qbk>\1</qbk> \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<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." \

2
doc/generated/append.qbk
View File

@ -41,7 +41,7 @@ Or
`#include <boost/geometry/algorithms/append.hpp>`
[include ref/algorithms/append.qbk]
[include reference/algorithms/append.qbk]
[endsect]

4
doc/generated/area.qbk
View File

@ -45,7 +45,7 @@ Or
`#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 @@ Or
`#include <boost/geometry/algorithms/area.hpp>`
[include ref/algorithms/area.qbk]
[include reference/algorithms/area.qbk]
[heading Examples]
[area] [area_output]

2
doc/generated/buffer.qbk
View File

@ -44,7 +44,7 @@ Or
`#include <boost/geometry/algorithms/buffer.hpp>`
[include ref/algorithms/buffer.qbk]
[include reference/algorithms/buffer.qbk]
[endsect]

8
doc/generated/centroid.qbk
View File

@ -42,7 +42,7 @@ Or
`#include <boost/geometry/algorithms/centroid.hpp>`
[include ref/algorithms/centroid.qbk]
[include reference/algorithms/centroid.qbk]
[endsect]
@ -77,7 +77,7 @@ Or
`#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 @@ Or
`#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 @@ 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

9
doc/generated/difference.qbk
View File

@ -45,7 +45,7 @@ Or
`#include <boost/geometry/algorithms/difference.hpp>`
[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<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator>
@ -86,8 +86,7 @@ Or
`#include <boost/geometry/algorithms/difference.hpp>`
[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<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>

4
doc/generated/get.qbk
View File

@ -46,7 +46,7 @@ Or
`#include <boost/geometry/core/access.hpp>`
[include ref/core/get_box.qbk]
[include reference/core/get_box.qbk]
[endsect]
@ -72,7 +72,7 @@ coordinate_type<Geometry>::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

6
doc/generated/intersection.qbk
View File

@ -43,7 +43,7 @@ Or
`#include <boost/geometry/algorithms/intersection.hpp>`
[include ref/algorithms/intersection.qbk]
[include reference/algorithms/intersection.qbk]
[endsect]
@ -76,7 +76,7 @@ The output iterator
[heading Header]
`#include <boost/geometry/algorithms/intersection_inserter.hpp>`
[include ref/algorithms/intersection.qbk]
[include reference/algorithms/intersection.qbk]
[endsect]
@ -110,7 +110,7 @@ The output iterator
[heading Header]
`#include <boost/geometry/algorithms/intersection_inserter.hpp>`
[include ref/algorithms/intersection.qbk]
[include reference/algorithms/intersection.qbk]
[endsect]

4
doc/generated/intersects.qbk
View File

@ -42,7 +42,7 @@ Or
`#include <boost/geometry/algorithms/intersects.hpp>`
[include ref/algorithms/intersects.qbk]
[include reference/algorithms/intersects.qbk]
[endsect]
@ -75,7 +75,7 @@ Or
`#include <boost/geometry/algorithms/intersects.hpp>`
[include ref/algorithms/intersects.qbk]
[include reference/algorithms/intersects.qbk]
[endsect]

4
doc/generated/length.qbk
View File

@ -45,7 +45,7 @@ Or
`#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 @@ Or
`#include <boost/geometry/algorithms/length.hpp>`
[include ref/algorithms/length.qbk]
[include reference/algorithms/length.qbk]
[length] [length_output]

2
doc/generated/num_geometries.qbk
View File

@ -44,7 +44,7 @@ Or
`#include <boost/geometry/algorithms/num_geometries.hpp>`
[include ref/algorithms/num_geometries.qbk]
[include reference/algorithms/num_geometries.qbk]
[endsect]

2
doc/generated/num_interior_rings.qbk
View File

@ -44,7 +44,7 @@ Or
`#include <boost/geometry/algorithms/num_interior_rings.hpp>`
[include ref/algorithms/num_interior_rings.qbk]
[include reference/algorithms/num_interior_rings.qbk]
[endsect]

2
doc/generated/num_points.qbk
View File

@ -45,7 +45,7 @@ Or
`#include <boost/geometry/algorithms/num_points.hpp>`
[include ref/algorithms/num_points.qbk]
[include reference/algorithms/num_points.qbk]
[endsect]

4
doc/generated/perimeter.qbk
View File

@ -45,7 +45,7 @@ Or
`#include <boost/geometry/algorithms/perimeter.hpp>`
[include ref/algorithms/perimeter.qbk]
[include reference/algorithms/perimeter.qbk]
[endsect]
@ -81,7 +81,7 @@ Or
`#include <boost/geometry/algorithms/perimeter.hpp>`
[include ref/algorithms/perimeter.qbk]
[include reference/algorithms/perimeter.qbk]
[endsect]

2
doc/generated/point.qbk
View File

@ -95,7 +95,7 @@ Or
`#include <boost/geometry/geometries/point.hpp>`
[include ref/geometries/point.qbk]
[include reference/geometries/point.qbk]
[endsect]

2
doc/generated/register.qbk
View File

@ -38,7 +38,7 @@ The macro BOOST\u005fGEOMETRY\u005fREGISTER\u005fPOINT\u005f2D registers a two-d
[heading Header]
`#include <boost/geometry/geometries/register/point.hpp>`
[include ref/geometries/register/point.qbk]
[include reference/geometries/register/point.qbk]
[endsect]

4
doc/generated/set.qbk
View File

@ -44,7 +44,7 @@ Or
`#include <boost/geometry/core/access.hpp>`
[include ref/core/set_box.qbk]
[include reference/core/set_box.qbk]
[endsect]
@ -79,7 +79,7 @@ Or
`#include <boost/geometry/core/access.hpp>`
[include ref/core/set_point.qbk]
[include reference/core/set_point.qbk]
[endsect]

6
doc/generated/simplify.qbk
View File

@ -40,7 +40,7 @@ Or
`#include <boost/geometry/algorithms/simplify.hpp>`
[include ref/algorithms/simplify.qbk]
[include reference/algorithms/simplify.qbk]
[endsect]
@ -103,7 +103,7 @@ Or
`#include <boost/geometry/algorithms/simplify.hpp>`
[include ref/algorithms/simplify_inserter.qbk]
[include reference/algorithms/simplify_inserter.qbk]
[endsect]
@ -136,7 +136,7 @@ Or
`#include <boost/geometry/algorithms/simplify.hpp>`
[include ref/algorithms/simplify.qbk]
[include reference/algorithms/simplify.qbk]
[endsect]

4
doc/generated/sym_difference.qbk
View File

@ -43,7 +43,7 @@ Or
`#include <boost/geometry/algorithms/sym_difference.hpp>`
[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<typename GeometryOut, typename Geometry1, typename Geometry2, typename OutputIterator, typename Strategy>

2
doc/generated/union.qbk
View File

@ -43,7 +43,7 @@ Or
`#include <boost/geometry/algorithms/union.hpp>`
[include ref/algorithms/union.qbk]
[include reference/algorithms/union.qbk]
[endsect]

BIN
doc/other/status.xls Normal file
View File

Binary file not shown.

1
doc/reference.qbk
View File

@ -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]

19
doc/reference/algorithms/overlay_behavior.qbk Normal file
View File

@ -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__]]
]