|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r68368 - in trunk/libs/geometry/doc: . doxy doxy/doxygen_input/groups ref/algorithms reference src/docutils/tools/doxygen_xml2qbk
From: barend.gehrels_at_[hidden]
Date: 2011-01-22 12:37:06
Author: barendgehrels
Date: 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
New Revision: 68368
URL: http://svn.boost.org/trac/boost/changeset/68368
Log:
Doc update
New: qbk_begin and qbk_end , often more convenient then {qbk..}
Removed:
trunk/libs/geometry/doc/reference/area_by_triangles.qbk
Text files modified:
trunk/libs/geometry/doc/doxy/Doxyfile | 5 +++++
trunk/libs/geometry/doc/doxy/doxygen_input/groups/groups.hpp | 3 ++-
trunk/libs/geometry/doc/make_qbk.py | 2 +-
trunk/libs/geometry/doc/quickref.xml | 2 +-
trunk/libs/geometry/doc/ref/algorithms/area.qbk | 1 -
trunk/libs/geometry/doc/reference.qbk | 2 +-
trunk/libs/geometry/doc/reference/append.qbk | 2 +-
trunk/libs/geometry/doc/reference/area.qbk | 12 ++++++++++--
trunk/libs/geometry/doc/reference/area_huiller.qbk | 18 +++++++++++++-----
trunk/libs/geometry/doc/reference/arithmetic.qbk | 2 +-
trunk/libs/geometry/doc/reference/assign.qbk | 2 +-
trunk/libs/geometry/doc/reference/box.qbk | 6 ++++--
trunk/libs/geometry/doc/reference/box_iterator.qbk | 4 +++-
trunk/libs/geometry/doc/reference/box_range.qbk | 4 +++-
trunk/libs/geometry/doc/reference/buffer.qbk | 2 +-
trunk/libs/geometry/doc/reference/cartesian.qbk | 4 +++-
trunk/libs/geometry/doc/reference/centroid.qbk | 2 +-
trunk/libs/geometry/doc/reference/centroid_average.qbk | 4 +++-
trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk | 4 +++-
trunk/libs/geometry/doc/reference/circular_iterator.qbk | 4 +++-
trunk/libs/geometry/doc/reference/clear.qbk | 2 +-
trunk/libs/geometry/doc/reference/closeable_view.qbk | 4 +++-
trunk/libs/geometry/doc/reference/closing_iterator.qbk | 4 +++-
trunk/libs/geometry/doc/reference/closure.qbk | 4 +++-
trunk/libs/geometry/doc/reference/combine.qbk | 2 +-
trunk/libs/geometry/doc/reference/convert.qbk | 2 +-
trunk/libs/geometry/doc/reference/convex_hull.qbk | 2 +-
trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk | 4 +++-
trunk/libs/geometry/doc/reference/coordinate_system.qbk | 4 +++-
trunk/libs/geometry/doc/reference/coordinate_type.qbk | 4 +++-
trunk/libs/geometry/doc/reference/correct.qbk | 2 +-
trunk/libs/geometry/doc/reference/cs_tag.qbk | 4 +++-
trunk/libs/geometry/doc/reference/difference.qbk | 2 +-
trunk/libs/geometry/doc/reference/dimension.qbk | 4 +++-
trunk/libs/geometry/doc/reference/disjoint.qbk | 2 +-
trunk/libs/geometry/doc/reference/dissolve.qbk | 2 +-
trunk/libs/geometry/doc/reference/distance.qbk | 7 ++++++-
trunk/libs/geometry/doc/reference/distance_cross_track.qbk | 12 ++++++++----
trunk/libs/geometry/doc/reference/distance_haversine.qbk | 32 ++++++++++++++++++++------------
trunk/libs/geometry/doc/reference/distance_projected_point.qbk | 17 ++++++++++-------
trunk/libs/geometry/doc/reference/distance_pythagoras.qbk | 17 +++++++++++++----
trunk/libs/geometry/doc/reference/envelope.qbk | 2 +-
trunk/libs/geometry/doc/reference/equals.qbk | 2 +-
trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk | 5 ++---
trunk/libs/geometry/doc/reference/exception.qbk | 4 +++-
trunk/libs/geometry/doc/reference/exterior_ring.qbk | 2 +-
trunk/libs/geometry/doc/reference/for_each.qbk | 14 +-------------
trunk/libs/geometry/doc/reference/geographic.qbk | 4 +++-
trunk/libs/geometry/doc/reference/geometry_id.qbk | 4 +++-
trunk/libs/geometry/doc/reference/get.qbk | 2 +-
trunk/libs/geometry/doc/reference/identity_view.qbk | 4 +++-
trunk/libs/geometry/doc/reference/interior_rings.qbk | 2 +-
trunk/libs/geometry/doc/reference/interior_type.qbk | 4 +++-
trunk/libs/geometry/doc/reference/intersection.qbk | 2 +-
trunk/libs/geometry/doc/reference/intersects.qbk | 2 +-
trunk/libs/geometry/doc/reference/is_radian.qbk | 4 +++-
trunk/libs/geometry/doc/reference/length.qbk | 2 +-
trunk/libs/geometry/doc/reference/linestring.qbk | 4 +++-
trunk/libs/geometry/doc/reference/make.qbk | 2 +-
trunk/libs/geometry/doc/reference/multi_linestring.qbk | 4 +++-
trunk/libs/geometry/doc/reference/multi_point.qbk | 4 +++-
trunk/libs/geometry/doc/reference/multi_polygon.qbk | 4 +++-
trunk/libs/geometry/doc/reference/num_geometries.qbk | 2 +-
trunk/libs/geometry/doc/reference/num_interior_rings.qbk | 2 +-
trunk/libs/geometry/doc/reference/num_points.qbk | 2 +-
trunk/libs/geometry/doc/reference/overlaps.qbk | 2 +-
trunk/libs/geometry/doc/reference/perimeter.qbk | 2 +-
trunk/libs/geometry/doc/reference/point.qbk | 6 ++++--
trunk/libs/geometry/doc/reference/point_order.qbk | 4 +++-
trunk/libs/geometry/doc/reference/point_type.qbk | 4 +++-
trunk/libs/geometry/doc/reference/point_xy.qbk | 11 ++++++-----
trunk/libs/geometry/doc/reference/polar.qbk | 7 +++++--
trunk/libs/geometry/doc/reference/polygon.qbk | 4 +++-
trunk/libs/geometry/doc/reference/referring_segment.qbk | 4 +++-
trunk/libs/geometry/doc/reference/register.qbk | 2 +-
trunk/libs/geometry/doc/reference/reverse.qbk | 2 +-
trunk/libs/geometry/doc/reference/reversible_view.qbk | 4 +++-
trunk/libs/geometry/doc/reference/ring.qbk | 4 +++-
trunk/libs/geometry/doc/reference/ring_type.qbk | 4 +++-
trunk/libs/geometry/doc/reference/segment.qbk | 4 +++-
trunk/libs/geometry/doc/reference/segment_range.qbk | 4 +++-
trunk/libs/geometry/doc/reference/segment_range_iterator.qbk | 4 +++-
trunk/libs/geometry/doc/reference/set.qbk | 2 +-
trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk | 4 +++-
trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk | 4 +++-
trunk/libs/geometry/doc/reference/simplify.qbk | 2 +-
trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk | 6 ++++--
trunk/libs/geometry/doc/reference/spherical.qbk | 4 +++-
trunk/libs/geometry/doc/reference/sym_difference.qbk | 2 +-
trunk/libs/geometry/doc/reference/tag.qbk | 6 ++++--
trunk/libs/geometry/doc/reference/topological_dimension.qbk | 4 +++-
trunk/libs/geometry/doc/reference/transform.qbk | 2 +-
trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk | 4 +++-
trunk/libs/geometry/doc/reference/transform_map_transformer.qbk | 4 +++-
trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk | 4 +++-
trunk/libs/geometry/doc/reference/transform_scale_transformer.qbk | 4 +++-
trunk/libs/geometry/doc/reference/transform_translate_transformer.qbk | 4 +++-
trunk/libs/geometry/doc/reference/transform_ublas_transformer.qbk | 4 +++-
trunk/libs/geometry/doc/reference/union.qbk | 2 +-
trunk/libs/geometry/doc/reference/unique.qbk | 2 +-
trunk/libs/geometry/doc/reference/within.qbk | 2 +-
trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk | 4 +++-
trunk/libs/geometry/doc/reference/within_franklin.qbk | 4 +++-
trunk/libs/geometry/doc/reference/within_winding.qbk | 4 +++-
trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_elements.hpp | 5 ++++-
trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp | 2 +-
trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/file_to_string.hpp | 13 ++-----------
107 files changed, 304 insertions(+), 167 deletions(-)
Modified: trunk/libs/geometry/doc/doxy/Doxyfile
==============================================================================
--- trunk/libs/geometry/doc/doxy/Doxyfile (original)
+++ trunk/libs/geometry/doc/doxy/Doxyfile 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -39,6 +39,8 @@
# \return* for various return cases
ALIASES = qbk{2}="\xmlonly <qbk.\1>\2</qbk.\1> \endxmlonly" \
qbk{1}="\xmlonly <qbk>\1</qbk> \endxmlonly" \
+ qbk_begin="\xmlonly <qbk>" \
+ qbk_end="</qbk> \endxmlonly" \
brief_calc{1}="Calculates the \1 of a geometry" \
brief_calc2{1}="Calculate the \1 of two geometries" \
brief_calc2{2}="Calculate the \1 \2 two geometries" \
@@ -55,6 +57,9 @@
tparam_box="Any type fulfilling a Box Concept" \
tparam_strategy{1}="Any type fulfilling a \1 Strategy Concept" \
tparam_numeric="Numerical type (int, double, ttmath, ...)" \
+ tparam_calculation="optional, numeric type for calculation (e.g. high precision)" \
+ tparam_optional_second_point="optional, second point type, defaults to first point type" \
+ tparam_optional_segment_point="optional, segment point type, defaults to point type" \
tparam_out{1}="A valid output iterator type, accepting geometries of \1 Concept" \
param_geometry="A model of the specified concept" \
param_box="A model of the specified Box Concept" \
Modified: trunk/libs/geometry/doc/doxy/doxygen_input/groups/groups.hpp
==============================================================================
--- trunk/libs/geometry/doc/doxy/doxygen_input/groups/groups.hpp (original)
+++ trunk/libs/geometry/doc/doxy/doxygen_input/groups/groups.hpp 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -6,7 +6,8 @@
// http://www.boost.org/LICENSE_1_0.txt)
// File defining groups for Doxygen.
// Note that group descriptions are (currently) not used.
-/*
+
+/*!
\defgroup access access: get/set coordinate values, make objects, clear geometries, append point(s)
\defgroup append append: append points to geometries
\defgroup area area: calculate area of a Geometry
Modified: trunk/libs/geometry/doc/make_qbk.py
==============================================================================
--- trunk/libs/geometry/doc/make_qbk.py (original)
+++ trunk/libs/geometry/doc/make_qbk.py 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -76,7 +76,7 @@
strategies = ["distance::pythagoras", "distance::haversine"
, "distance::cross_track", "distance::projected_point"
, "within::winding", "within::franklin", "within::crossings_multiply"
- , "area::by_triangles", "area::huiller"
+ , "area::surveyor", "area::huiller"
, "centroid::bashein_detmer", "centroid::average"
, "convex_hull::graham_andrew"
, "simplify::douglas_peucker"
Modified: trunk/libs/geometry/doc/quickref.xml
==============================================================================
--- trunk/libs/geometry/doc/quickref.xml (original)
+++ trunk/libs/geometry/doc/quickref.xml 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -447,7 +447,7 @@
<entry valign="top">
<bridgehead renderas="sect3">Area</bridgehead>
<simplelist type="vert" columns="1">
- <member><link linkend="geometry.reference.strategies.strategy_area_by_triangles">strategy::area::by_triangles</link></member>
+ <member><link linkend="geometry.reference.strategies.strategy_area_surveyor">strategy::area::surveyor</link></member>
<member><link linkend="geometry.reference.strategies.strategy_area_huiller">strategy::area::huiller</link></member>
</simplelist>
</entry>
Modified: trunk/libs/geometry/doc/ref/algorithms/area.qbk
==============================================================================
--- trunk/libs/geometry/doc/ref/algorithms/area.qbk (original)
+++ trunk/libs/geometry/doc/ref/algorithms/area.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -24,4 +24,3 @@
[heading Complexity]
Linear
-[heading Examples] [/ filled by doxml2qbk]
Modified: trunk/libs/geometry/doc/reference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference.qbk (original)
+++ trunk/libs/geometry/doc/reference.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -218,7 +218,7 @@
[include reference/distance_haversine.qbk]
[include reference/distance_projected_point.qbk]
[include reference/distance_cross_track.qbk]
-[include reference/area_by_triangles.qbk]
+[include reference/area_surveyor.qbk]
[include reference/area_huiller.qbk]
[include reference/centroid_average.qbk]
[include reference/centroid_bashein_detmer.qbk]
Modified: trunk/libs/geometry/doc/reference/append.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/append.qbk (original)
+++ trunk/libs/geometry/doc/reference/append.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__append.xml]
[section:append append]
Modified: trunk/libs/geometry/doc/reference/area.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/area.qbk (original)
+++ trunk/libs/geometry/doc/reference/area.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__area.xml]
[section:area_2_with_strategy area (with strategy)]
@@ -46,7 +46,14 @@
`#include <boost/geometry/algorithms/area.hpp>`
[include ref/algorithms/area.qbk]
-[area_with_strategy] [area_with_strategy_output]
+
+[heading Example]
+[area_with_strategy]
+[area_with_strategy_output]
+
+[heading Available strategies]
+* [link geometry.reference.strategies.strategy_area_surveyor Surveyor (cartesian)]
+* [link geometry.reference.strategies.strategy_area_huiller Huiller (spherical)]
[endsect]
@@ -86,6 +93,7 @@
`#include <boost/geometry/algorithms/area.hpp>`
[include ref/algorithms/area.qbk]
+[heading Examples]
[area] [area_output]
[endsect]
Deleted: trunk/libs/geometry/doc/reference/area_by_triangles.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/area_by_triangles.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
+++ (empty file)
@@ -1,65 +0,0 @@
-[/============================================================================
- Boost.Geometry (aka GGL, Generic Geometry Library)
-
- Copyright (c) 2009-2011 Barend Gehrels, Geodan, Amsterdam, the Netherlands.
- Copyright (c) 2009-2011 Mateusz Loskot (mateusz_at_[hidden])
- Copyright (c) 2009-2011 Bruno Lalande, Paris, France.
-
- 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)
-=============================================================================/]
-
-
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
-[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1area_1_1by__triangles.xml]
-[section:strategy_area_by_triangles strategy::area::by_triangles]
-
-[heading Description]
-Calculates area using well-known triangulation algorithm
-
-[heading Synopsis]
-``template<typename PointOfSegment, typename CalculationType>
-class strategy::area::by_triangles
-{
- // ...
-};
-``
-
-[heading Template parameter(s)]
-[table
-[[Parameter] [Description]]
-[[typename PointOfSegment] [point type of segments ]]
-[[typename CalculationType] []]
-]
-
-[heading Member Function(s)]
-[table
-[[Function] [Description] [Parameters] [Returns] ]
-[[``void apply (PointOfSegment const &p1, PointOfSegment const &p2, summation &state)``
-
-] [] [[* PointOfSegment const &]: ['p1]:
-
-[* PointOfSegment const &]: ['p2]:
-
-[* summation &]: ['state]:
-
-
-
-
-]]
-[[`` result (summation const &state)``
-
-] [] [[* summation const &]: ['state]:
-
-
-
-
-]]
-]
-
-[heading Header]
-`#include <boost/geometry/strategies/cartesian/area_by_triangles.hpp>`
-
-[endsect]
-
Modified: trunk/libs/geometry/doc/reference/area_huiller.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/area_huiller.qbk (original)
+++ trunk/libs/geometry/doc/reference/area_huiller.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,14 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1area_1_1huiller.xml]
[section:strategy_area_huiller strategy::area::huiller]
+Area calculation by spherical excess / Huiller's formula.
+
[heading Synopsis]
-``template<typename PointOfSegment, typename CalculationType, >
+``template<typename PointOfSegment, typename CalculationType>
class strategy::area::huiller
{
// ...
@@ -26,9 +28,8 @@
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
-[[typename PointOfSegment] []]
-[[typename CalculationType] []]
-[[] [type of points of rings/polygons ]]
+[[typename PointOfSegment] [point type of segments of rings/polygons ]]
+[[typename CalculationType] [optional, numeric type for calculation (e.g. high precision) ]]
]
[heading Constructor(s)]
@@ -72,5 +73,12 @@
[heading Header]
`#include <boost/geometry/strategies/spherical/area_huiller.hpp>`
+[heading Example]
+[area_with_strategy]
+[area_with_strategy_output]
+
+
+[heading See also]
+[link geometry.reference.algorithms.area.area_2_with_strategy area]
[endsect]
Modified: trunk/libs/geometry/doc/reference/arithmetic.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/arithmetic.qbk (original)
+++ trunk/libs/geometry/doc/reference/arithmetic.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__arithmetic.xml]
[section:add_point add_point]
Modified: trunk/libs/geometry/doc/reference/assign.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/assign.qbk (original)
+++ trunk/libs/geometry/doc/reference/assign.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__assign.xml]
[section:assign_2 assign]
Modified: trunk/libs/geometry/doc/reference/box.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/box.qbk (original)
+++ trunk/libs/geometry/doc/reference/box.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,14 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1box.xml]
[section:model_box model::box]
+Class box: defines a box made of two describing points.
+
[heading Description]
-Box is always described by a
+Box is always described by a min_corner() and a max_corner() point. If another rectangle is used, use linear_ring or polygon.
[heading Synopsis]
``template<typename Point>
Modified: trunk/libs/geometry/doc/reference/box_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/box_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/box_iterator.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1box__iterator.xml]
[section:box_iterator box_iterator]
+Iterator which adapts a box (four points + closing) as iterator.
+
[heading Synopsis]
``template<typename Box>
class box_iterator
Modified: trunk/libs/geometry/doc/reference/box_range.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/box_range.qbk (original)
+++ trunk/libs/geometry/doc/reference/box_range.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1box__range.xml]
[section:box_range box_range]
+Range, walking over the four points of a box.
+
[heading Synopsis]
``template<typename Box>
class box_range
Modified: trunk/libs/geometry/doc/reference/buffer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/buffer.qbk (original)
+++ trunk/libs/geometry/doc/reference/buffer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__buffer.xml]
[section:buffer buffer]
Modified: trunk/libs/geometry/doc/reference/cartesian.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/cartesian.qbk (original)
+++ trunk/libs/geometry/doc/reference/cartesian.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1cs_1_1cartesian.xml]
[section:cs_cartesian cs::cartesian]
+Cartesian coordinate system.
+
[heading Description]
Defines the Cartesian or rectangular coordinate system where points are defined in 2 or 3 (or more) dimensions and usually (but not always) known as x,y,z
Modified: trunk/libs/geometry/doc/reference/centroid.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/centroid.qbk (original)
+++ trunk/libs/geometry/doc/reference/centroid.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__centroid.xml]
[section:centroid_2 centroid]
Modified: trunk/libs/geometry/doc/reference/centroid_average.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/centroid_average.qbk (original)
+++ trunk/libs/geometry/doc/reference/centroid_average.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1centroid_1_1average.xml]
[section:strategy_centroid_average strategy::centroid::average]
+Centroid calculation taking average of points.
+
[heading Synopsis]
``template<typename PointCentroid, typename Point>
class strategy::centroid::average
Modified: trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk (original)
+++ trunk/libs/geometry/doc/reference/centroid_bashein_detmer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1centroid_1_1bashein__detmer.xml]
[section:strategy_centroid_bashein_detmer strategy::centroid::bashein_detmer]
+Centroid calculation using algorith Bashein / Detmer.
+
[heading Description]
Calculates centroid using triangulation method published by Bashein / Detmer
Modified: trunk/libs/geometry/doc/reference/circular_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/circular_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/circular_iterator.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1circular__iterator.xml]
[section:circular_iterator circular_iterator]
+Iterator which goes circular through a range, starting at a point, ending at that point.
+
[heading Synopsis]
``template<typename Iterator>
class circular_iterator
Modified: trunk/libs/geometry/doc/reference/clear.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/clear.qbk (original)
+++ trunk/libs/geometry/doc/reference/clear.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__clear.xml]
[section:clear clear]
Modified: trunk/libs/geometry/doc/reference/closeable_view.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/closeable_view.qbk (original)
+++ trunk/libs/geometry/doc/reference/closeable_view.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1closeable__view.xml]
[section:closeable_view closeable_view]
+View on a range, either closing or not closing.
+
[heading Synopsis]
``template<typename Range, Close>
class closeable_view
Modified: trunk/libs/geometry/doc/reference/closing_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/closing_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/closing_iterator.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1closing__iterator.xml]
[section:closing_iterator closing_iterator]
+Iterator which iterates through a range, but adds first element at end of the range.
+
[heading Synopsis]
``template<typename Range>
class closing_iterator
Modified: trunk/libs/geometry/doc/reference/closure.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/closure.qbk (original)
+++ trunk/libs/geometry/doc/reference/closure.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1closure.xml]
[section:closure closure]
+Meta-function which defines closure of any geometry.
+
[heading Synopsis]
``template<typename Geometry>
class closure
Modified: trunk/libs/geometry/doc/reference/combine.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/combine.qbk (original)
+++ trunk/libs/geometry/doc/reference/combine.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__combine.xml]
[section:combine combine]
Modified: trunk/libs/geometry/doc/reference/convert.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/convert.qbk (original)
+++ trunk/libs/geometry/doc/reference/convert.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__convert.xml]
[section:convert convert]
Modified: trunk/libs/geometry/doc/reference/convex_hull.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/convex_hull.qbk (original)
+++ trunk/libs/geometry/doc/reference/convex_hull.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__convex__hull.xml]
[section:convex_hull convex_hull]
Modified: trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk (original)
+++ trunk/libs/geometry/doc/reference/convex_hull_graham_andrew.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1convex__hull_1_1graham__andrew.xml]
[section:strategy_convex_hull_graham_andrew strategy::convex_hull::graham_andrew]
+Graham scan strategy to calculate convex hull.
+
[heading Synopsis]
``template<typename InputGeometry, typename OutputPoint>
class strategy::convex_hull::graham_andrew
Modified: trunk/libs/geometry/doc/reference/coordinate_system.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/coordinate_system.qbk (original)
+++ trunk/libs/geometry/doc/reference/coordinate_system.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1coordinate__system.xml]
[section:coordinate_system coordinate_system]
+Meta-function which defines coordinate system for any geometry.
+
[heading Synopsis]
``template<typename G>
class coordinate_system
Modified: trunk/libs/geometry/doc/reference/coordinate_type.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/coordinate_type.qbk (original)
+++ trunk/libs/geometry/doc/reference/coordinate_type.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1coordinate__type.xml]
[section:coordinate_type coordinate_type]
+Meta-function which defines coordinate type (int, float, double, etc) of any geometry.
+
[heading Synopsis]
``template<typename Geometry>
class coordinate_type
Modified: trunk/libs/geometry/doc/reference/correct.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/correct.qbk (original)
+++ trunk/libs/geometry/doc/reference/correct.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__correct.xml]
[section:correct correct]
Modified: trunk/libs/geometry/doc/reference/cs_tag.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/cs_tag.qbk (original)
+++ trunk/libs/geometry/doc/reference/cs_tag.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1cs__tag.xml]
[section:cs_tag cs_tag]
+Meta-function returning coordinate system tag (cs family) of any geometry.
+
[heading Synopsis]
``template<typename G>
class cs_tag
Modified: trunk/libs/geometry/doc/reference/difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/difference.qbk (original)
+++ trunk/libs/geometry/doc/reference/difference.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__difference.xml]
[section:difference difference]
Modified: trunk/libs/geometry/doc/reference/dimension.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/dimension.qbk (original)
+++ trunk/libs/geometry/doc/reference/dimension.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1dimension.xml]
[section:dimension dimension]
+Meta-function which defines coordinate dimensions, i.e. the number of axes of any geometry.
+
[heading Synopsis]
``template<typename G>
class dimension
Modified: trunk/libs/geometry/doc/reference/disjoint.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/disjoint.qbk (original)
+++ trunk/libs/geometry/doc/reference/disjoint.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__disjoint.xml]
[section:disjoint disjoint]
Modified: trunk/libs/geometry/doc/reference/dissolve.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/dissolve.qbk (original)
+++ trunk/libs/geometry/doc/reference/dissolve.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,5 +11,5 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__dissolve.xml]
Modified: trunk/libs/geometry/doc/reference/distance.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__distance.xml]
[section:comparable_distance comparable_distance]
@@ -110,6 +110,11 @@
`#include <boost/geometry/algorithms/distance.hpp>`
+[heading Available strategies]
+* [link geometry.reference.strategies.strategy_distance_pythagoras Pythagoras (cartesian)]
+* [link geometry.reference.strategies.strategy_distance_haversine Haversine (spherical)]
+* [link geometry.reference.strategies.strategy_distance_cross_track Cross track (spherical, point-to-segment)]
+* [link geometry.reference.strategies.strategy_distance_projected_point Projected point (cartesian, point-to-segment)]
[endsect]
Modified: trunk/libs/geometry/doc/reference/distance_cross_track.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_cross_track.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_cross_track.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1cross__track.xml]
[section:strategy_distance_cross_track strategy::distance::cross_track]
+Strategy functor for distance point to segment calculation.
+
[heading Description]
Class which calculates the distance of a point to a segment, using latlong points
@@ -30,9 +32,9 @@
[table
[[Parameter] [Description]]
[[typename Point] [point type ]]
-[[typename PointOfSegment] [type of point-of-segment ]]
-[[typename CalculationType] []]
-[[typename Strategy] []]
+[[typename PointOfSegment] [optional, segment point type, defaults to point type ]]
+[[typename CalculationType] [optional, numeric type for calculation (e.g. high precision) ]]
+[[typename Strategy] [strategy, optional, underlying point-point distance strategy, defaults to haversine]]
]
[heading Constructor(s)]
@@ -88,5 +90,7 @@
[heading Header]
`#include <boost/geometry/strategies/spherical/distance_cross_track.hpp>`
+[heading See also]
+[link geometry.reference.algorithms.distance.distance_3_with_strategy distance]
[endsect]
Modified: trunk/libs/geometry/doc/reference/distance_haversine.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_haversine.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_haversine.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,14 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1haversine.xml]
[section:strategy_distance_haversine strategy::distance::haversine]
+Distance calculation for spherical coordinates on a perfect sphere using haversine.
+
[heading Synopsis]
-``template<typename Point1, typename Point2, typename CalculationType, , >
+``template<typename Point1, typename Point2, typename CalculationType>
class strategy::distance::haversine
{
// ...
@@ -26,19 +28,17 @@
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
-[[typename Point1] []]
-[[typename Point2] []]
-[[typename CalculationType] []]
-[[] [first point type ]]
-[[] [optional second point type ]]
+[[typename Point1] [first point type ]]
+[[typename Point2] [optional, second point type, defaults to first point type ]]
+[[typename CalculationType] [optional, numeric type for calculation (e.g. high precision) ]]
]
[heading Constructor(s)]
[table
[[Function] [Description] [Parameters] ]
-[[``haversine (calculation_type const &r=1.0)``
+[[``haversine (calculation_type const &radius=1.0)``
-] [] [[* const &]: ['r]:
+] [Constructor. ] [[* const &]: ['radius]: radius of the sphere, defaults to 1.0 for the unit sphere
@@ -51,17 +51,23 @@
[[Function] [Description] [Parameters] [Returns] ]
[[`` apply (Point1 const &p1, Point2 const &p2) const ``
-] [] [[* Point1 const &]: ['p1]:
+] [applies the distance calculation ] [[* Point1 const &]: ['p1]: first point
+
+[* Point2 const &]: ['p2]: second point
-[* Point2 const &]: ['p2]:
+][
+the calculated distance (including multiplying with radius)
]]
[[`` radius () const ``
-] [] [
+] [access to radius value ] [
+
+][
+the radius
]]
@@ -70,5 +76,7 @@
[heading Header]
`#include <boost/geometry/strategies/spherical/distance_haversine.hpp>`
+[heading See also]
+[link geometry.reference.algorithms.distance.distance_3_with_strategy distance]
[endsect]
Modified: trunk/libs/geometry/doc/reference/distance_projected_point.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_projected_point.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_projected_point.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,15 +11,17 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1projected__point.xml]
[section:strategy_distance_projected_point strategy::distance::projected_point]
+Strategy for distance point to segment.
+
[heading Description]
Calculates distance using projected-point method, and (optionally) Pythagoras
[heading Synopsis]
-``template<typename Point, typename PointOfSegment, typename CalculationType, typename Strategy, >
+``template<typename Point, typename PointOfSegment, typename CalculationType, typename Strategy>
class strategy::distance::projected_point
{
// ...
@@ -29,11 +31,10 @@
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
-[[typename Point] []]
-[[typename PointOfSegment] [segment type ]]
-[[typename CalculationType] []]
-[[typename Strategy] [strategy, optional, defaults to pythagoras ]]
-[[] [point type ]]
+[[typename Point] [point type ]]
+[[typename PointOfSegment] [optional, segment point type, defaults to point type ]]
+[[typename CalculationType] [optional, numeric type for calculation (e.g. high precision) ]]
+[[typename Strategy] [strategy, optional, underlying point-point distance strategy, defaults to pythagoras ]]
]
[heading Member Function(s)]
@@ -56,5 +57,7 @@
[heading Header]
`#include <boost/geometry/strategies/cartesian/distance_projected_point.hpp>`
+[heading See also]
+[link geometry.reference.algorithms.distance.distance_3_with_strategy distance]
[endsect]
Modified: trunk/libs/geometry/doc/reference/distance_pythagoras.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/distance_pythagoras.qbk (original)
+++ trunk/libs/geometry/doc/reference/distance_pythagoras.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1distance_1_1pythagoras.xml]
[section:strategy_distance_pythagoras strategy::distance::pythagoras]
+Strategy to calculate the distance between two points.
+
[heading Synopsis]
``template<typename Point1, typename Point2, typename CalculationType>
class strategy::distance::pythagoras
@@ -28,7 +30,7 @@
[[Parameter] [Description]]
[[typename Point1] [first point type ]]
[[typename Point2] [optional, second point type, defaults to first point type ]]
-[[typename CalculationType] [optional, specify type of calculation ]]
+[[typename CalculationType] [optional, numeric type for calculation (e.g. high precision)]]
]
[heading Member Function(s)]
@@ -36,11 +38,14 @@
[[Function] [Description] [Parameters] [Returns] ]
[[`` apply (Point1 const &p1, Point2 const &p2)``
-] [] [[* Point1 const &]: ['p1]:
+] [applies the distance calculation using pythagoras ] [[* Point1 const &]: ['p1]: first point
+
+[* Point2 const &]: ['p2]: second point
-[* Point2 const &]: ['p2]:
+][
+the calculated distance (including taking the square root)
]]
@@ -49,5 +54,9 @@
[heading Header]
`#include <boost/geometry/strategies/cartesian/distance_pythagoras.hpp>`
+[heading Notes]
+[note Can be used for points with two, three or more dimensions]
+[heading See also]
+[link geometry.reference.algorithms.distance.distance_3_with_strategy distance]
[endsect]
Modified: trunk/libs/geometry/doc/reference/envelope.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/envelope.qbk (original)
+++ trunk/libs/geometry/doc/reference/envelope.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__envelope.xml]
[section:envelope envelope]
Modified: trunk/libs/geometry/doc/reference/equals.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/equals.qbk (original)
+++ trunk/libs/geometry/doc/reference/equals.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__equals.xml]
[section:equals equals]
Modified: trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/ever_circling_iterator.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,11 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1ever__circling__iterator.xml]
[section:ever_circling_iterator ever_circling_iterator]
-[heading Description]
-If the iterator arrives at range.end() it restarts from the beginning. So it has to be stopped in another way. Don't call for(....; it++) because it will turn in an endless loop
+Iterator which ever circles through a range.
[heading Synopsis]
``template<typename Iterator>
Modified: trunk/libs/geometry/doc/reference/exception.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/exception.qbk (original)
+++ trunk/libs/geometry/doc/reference/exception.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1exception.xml]
[section:exception exception]
+Base exception class for GGL.
+
[heading Synopsis]
``class exception
{
Modified: trunk/libs/geometry/doc/reference/exterior_ring.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/exterior_ring.qbk (original)
+++ trunk/libs/geometry/doc/reference/exterior_ring.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__exterior__ring.xml]
[section:exterior_ring_1_const_version exterior_ring (const version)]
Modified: trunk/libs/geometry/doc/reference/for_each.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/for_each.qbk (original)
+++ trunk/libs/geometry/doc/reference/for_each.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,15 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__for__each.xml]
[section:for_each_point_2 for_each_point]
Calls functor for geometry.
-[heading Description]
-Calls the functor for the specified geometry
-
[heading Synopsis]
``template<typename Geometry, typename Functor>
Functor for_each_point (Geometry &geometry, Functor f)``
@@ -49,9 +46,6 @@
Calls functor for geometry.
-[heading Description]
-Calls the functor the specified
-
[heading Synopsis]
``template<typename Geometry, typename Functor>
Functor for_each_point (Geometry const &geometry, Functor f)``
@@ -81,9 +75,6 @@
Calls functor for segments on linestrings, rings, polygons, ...
-[heading Description]
-Calls the functor all segments of the specified geometry
-
[heading Synopsis]
``template<typename Geometry, typename Functor>
Functor for_each_segment (Geometry &geometry, Functor f)``
@@ -113,9 +104,6 @@
Calls functor for segments on linestrings, rings, polygons, ...
-[heading Description]
-Calls the functor all
-
[heading Synopsis]
``template<typename Geometry, typename Functor>
Functor for_each_segment (Geometry const &geometry, Functor f)``
Modified: trunk/libs/geometry/doc/reference/geographic.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/geographic.qbk (original)
+++ trunk/libs/geometry/doc/reference/geographic.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1cs_1_1geographic.xml]
[section:cs_geographic cs::geographic]
+Geographic coordinate system, in degree or in radian.
+
[heading Description]
Defines the geographic coordinate system where points are defined in two angles and usually known as lat,long or lo,la or phi,lambda
Modified: trunk/libs/geometry/doc/reference/geometry_id.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/geometry_id.qbk (original)
+++ trunk/libs/geometry/doc/reference/geometry_id.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1geometry__id.xml]
[section:geometry_id geometry_id]
+Meta-function the id for a geometry type.
+
[heading Synopsis]
``template<typename Geometry>
class geometry_id
Modified: trunk/libs/geometry/doc/reference/get.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/get.qbk (original)
+++ trunk/libs/geometry/doc/reference/get.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__get.xml]
[section:get get]
Modified: trunk/libs/geometry/doc/reference/identity_view.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/identity_view.qbk (original)
+++ trunk/libs/geometry/doc/reference/identity_view.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1identity__view.xml]
[section:identity_view identity_view]
+View on a range, not modifying anything.
+
[heading Synopsis]
``template<typename Range>
class identity_view
Modified: trunk/libs/geometry/doc/reference/interior_rings.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/interior_rings.qbk (original)
+++ trunk/libs/geometry/doc/reference/interior_rings.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__interior__rings.xml]
[section:interior_rings_1_const_version interior_rings (const version)]
Modified: trunk/libs/geometry/doc/reference/interior_type.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/interior_type.qbk (original)
+++ trunk/libs/geometry/doc/reference/interior_type.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1interior__type.xml]
[section:interior_type interior_type]
+Meta-function defining container type of inner rings of (multi)polygon geometriy.
+
[heading Description]
the interior rings should be organized as a container (std::vector, std::deque, boost::array) with boost range support. This meta function defines the type of that container.
Modified: trunk/libs/geometry/doc/reference/intersection.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/intersection.qbk (original)
+++ trunk/libs/geometry/doc/reference/intersection.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__intersection.xml]
[section:intersection intersection]
Modified: trunk/libs/geometry/doc/reference/intersects.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/intersects.qbk (original)
+++ trunk/libs/geometry/doc/reference/intersects.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__intersects.xml]
[section:intersects_2_two_geometries intersects (two geometries)]
Modified: trunk/libs/geometry/doc/reference/is_radian.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/is_radian.qbk (original)
+++ trunk/libs/geometry/doc/reference/is_radian.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1is__radian.xml]
[section:is_radian is_radian]
+Meta-function to verify if a coordinate system is radian.
+
[heading Synopsis]
``template<typename CoordinateSystem>
class is_radian
Modified: trunk/libs/geometry/doc/reference/length.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/length.qbk (original)
+++ trunk/libs/geometry/doc/reference/length.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__length.xml]
[section:length_2_with_strategy length (with strategy)]
Modified: trunk/libs/geometry/doc/reference/linestring.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/linestring.qbk (original)
+++ trunk/libs/geometry/doc/reference/linestring.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1linestring.xml]
[section:model_linestring model::linestring]
+Allocator linestring (named so by OGC) is a collection (default a vector) of points.
+
[heading Synopsis]
``template<typename Point, template< typename, typename > class Container, template< typename > class Allocator>
class model::linestring
Modified: trunk/libs/geometry/doc/reference/make.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/make.qbk (original)
+++ trunk/libs/geometry/doc/reference/make.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__make.xml]
[section:make_3 make]
Modified: trunk/libs/geometry/doc/reference/multi_linestring.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/multi_linestring.qbk (original)
+++ trunk/libs/geometry/doc/reference/multi_linestring.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1multi__linestring.xml]
[section:model_multi_linestring model::multi_linestring]
+multi_line, a collection of linestring
+
[heading Description]
Multi-linestring can be used to group lines belonging to each other, e.g. a highway (with interruptions)
Modified: trunk/libs/geometry/doc/reference/multi_point.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/multi_point.qbk (original)
+++ trunk/libs/geometry/doc/reference/multi_point.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1multi__point.xml]
[section:model_multi_point model::multi_point]
+multi_point, a collection of points
+
[heading Description]
Multipoint can be used to group points belonging to each other, e.g. a constellation
Modified: trunk/libs/geometry/doc/reference/multi_polygon.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/multi_polygon.qbk (original)
+++ trunk/libs/geometry/doc/reference/multi_polygon.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1multi__polygon.xml]
[section:model_multi_polygon model::multi_polygon]
+multi_polygon, a collection of polygons
+
[heading Description]
Multi-polygon can be used to group polygons belonging to each other, e.g. Hawaii
Modified: trunk/libs/geometry/doc/reference/num_geometries.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/num_geometries.qbk (original)
+++ trunk/libs/geometry/doc/reference/num_geometries.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__num__geometries.xml]
[section:num_geometries num_geometries]
Modified: trunk/libs/geometry/doc/reference/num_interior_rings.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/num_interior_rings.qbk (original)
+++ trunk/libs/geometry/doc/reference/num_interior_rings.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__num__interior__rings.xml]
[section:num_interior_rings num_interior_rings]
Modified: trunk/libs/geometry/doc/reference/num_points.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/num_points.qbk (original)
+++ trunk/libs/geometry/doc/reference/num_points.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__num__points.xml]
[section:num_points num_points]
Modified: trunk/libs/geometry/doc/reference/overlaps.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/overlaps.qbk (original)
+++ trunk/libs/geometry/doc/reference/overlaps.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__overlaps.xml]
[section:overlaps overlaps]
Modified: trunk/libs/geometry/doc/reference/perimeter.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/perimeter.qbk (original)
+++ trunk/libs/geometry/doc/reference/perimeter.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__perimeter.xml]
[section:perimeter_2_with_strategy perimeter (with strategy)]
Modified: trunk/libs/geometry/doc/reference/point.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/point.qbk (original)
+++ trunk/libs/geometry/doc/reference/point.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1point.xml]
[section:model_point model::point]
+Basic point class, having coordinates defined in a neutral way.
+
[heading Description]
Defines a neutral point class, fulfilling the Point Concept. Library users can use this point class, or use their own point classes. This point class is used in most of the samples and tests of Boost.Geometry This point class is used occasionally within the library, where a temporary point class is necessary.
@@ -31,7 +33,7 @@
[[Parameter] [Description]]
[[typename CoordinateType] [Numerical type (int, double, ttmath, ...) ]]
[[std::size_t DimensionCount] [number of coordinates, usually 2 or 3 ]]
-[[typename CoordinateSystem] [coordinate system, for example ]]
+[[typename CoordinateSystem] [coordinate system, for example cs::cartesian]]
]
[heading Constructor(s)]
Modified: trunk/libs/geometry/doc/reference/point_order.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/point_order.qbk (original)
+++ trunk/libs/geometry/doc/reference/point_order.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1point__order.xml]
[section:point_order point_order]
+Meta-function which defines point order of any geometry.
+
[heading Synopsis]
``template<typename Geometry>
class point_order
Modified: trunk/libs/geometry/doc/reference/point_type.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/point_type.qbk (original)
+++ trunk/libs/geometry/doc/reference/point_type.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1point__type.xml]
[section:point_type point_type]
+Meta-function which defines point type of any geometry.
+
[heading Synopsis]
``template<typename Geometry>
class point_type
Modified: trunk/libs/geometry/doc/reference/point_xy.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/point_xy.qbk (original)
+++ trunk/libs/geometry/doc/reference/point_xy.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,14 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1d2_1_1point__xy.xml]
[section:model_d2_point_xy model::d2::point_xy]
+2D point in Cartesian coordinate system
+
[heading Synopsis]
-``template<typename CoordinateType, typename CoordinateSystem, >
+``template<typename CoordinateType, typename CoordinateSystem>
class model::d2::point_xy
{
// ...
@@ -26,9 +28,8 @@
[heading Template parameter(s)]
[table
[[Parameter] [Description]]
-[[typename CoordinateType] []]
-[[typename CoordinateSystem] []]
-[[] [numeric type, arguments can be, for example, double, float, int ]]
+[[typename CoordinateType] [numeric type, for example, double, float, int ]]
+[[typename CoordinateSystem] [coordinate system, defaults to cs::cartesian]]
]
[heading Constructor(s)]
Modified: trunk/libs/geometry/doc/reference/polar.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/polar.qbk (original)
+++ trunk/libs/geometry/doc/reference/polar.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,15 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1cs_1_1polar.xml]
[section:cs_polar cs::polar]
+Polar coordinate system.
+
[heading Description]
-Defines the polar coordinate system "in which each pointon a plane is determined by an angle and a distance"
+Defines the polar coordinate system "in which each point
+ on a plane is determined by an angle and a distance"
[heading Synopsis]
``template<typename DegreeOrRadian>
Modified: trunk/libs/geometry/doc/reference/polygon.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/polygon.qbk (original)
+++ trunk/libs/geometry/doc/reference/polygon.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1polygon.xml]
[section:model_polygon model::polygon]
+The
+
[heading Synopsis]
``template<typename Point, bool ClockWise, bool Closed, template< typename, typename > class PointList, template< typename, typename > class RingList, template< typename > class PointAlloc, template< typename > class RingAlloc, >
class model::polygon
Modified: trunk/libs/geometry/doc/reference/referring_segment.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/referring_segment.qbk (original)
+++ trunk/libs/geometry/doc/reference/referring_segment.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1referring__segment.xml]
[section:model_referring_segment model::referring_segment]
+Class segment: small class containing two (templatized) point references.
+
[heading Description]
From Wikipedia: In geometry, a line segment is a part of a line that is bounded by two distinct end points, and contains every point on the line between its end points.
Modified: trunk/libs/geometry/doc/reference/register.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/register.qbk (original)
+++ trunk/libs/geometry/doc/reference/register.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__register.xml]
[section:boost_geometry_register_point_2d BOOST_GEOMETRY_REGISTER_POINT_2D]
Modified: trunk/libs/geometry/doc/reference/reverse.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/reverse.qbk (original)
+++ trunk/libs/geometry/doc/reference/reverse.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__reverse.xml]
[section:reverse reverse]
Modified: trunk/libs/geometry/doc/reference/reversible_view.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/reversible_view.qbk (original)
+++ trunk/libs/geometry/doc/reference/reversible_view.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1reversible__view.xml]
[section:reversible_view reversible_view]
+View on a range, reversing direction if necessary.
+
[heading Synopsis]
``template<typename Range, Direction>
class reversible_view
Modified: trunk/libs/geometry/doc/reference/ring.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/ring.qbk (original)
+++ trunk/libs/geometry/doc/reference/ring.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1linear__ring.xml]
[section:model_linear_ring model::linear_ring]
+A linear_ring (linear linear_ring) is a closed line which should not be selfintersecting.
+
[heading Synopsis]
``template<typename Point, bool ClockWise, bool Closed, template< typename, typename > class Container, template< typename > class Allocator>
class model::linear_ring
Modified: trunk/libs/geometry/doc/reference/ring_type.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/ring_type.qbk (original)
+++ trunk/libs/geometry/doc/reference/ring_type.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1ring__type.xml]
[section:ring_type ring_type]
+Meta-function which defines ring type of (multi)polygon geometry.
+
[heading Description]
a polygon contains one exterior ring and zero or more interior rings (holes). This meta function retrieves the type of the rings
Modified: trunk/libs/geometry/doc/reference/segment.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/segment.qbk (original)
+++ trunk/libs/geometry/doc/reference/segment.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1model_1_1segment.xml]
[section:model_segment model::segment]
+Class segment: small class containing two points.
+
[heading Description]
From Wikipedia: In geometry, a line segment is a part of a line that is bounded by two distinct end points, and contains every point on the line between its end points.
Modified: trunk/libs/geometry/doc/reference/segment_range.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/segment_range.qbk (original)
+++ trunk/libs/geometry/doc/reference/segment_range.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1segment__range.xml]
[section:segment_range segment_range]
+Range, walking over the two points of a segment.
+
[heading Synopsis]
``template<typename Segment>
class segment_range
Modified: trunk/libs/geometry/doc/reference/segment_range_iterator.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/segment_range_iterator.qbk (original)
+++ trunk/libs/geometry/doc/reference/segment_range_iterator.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1segment__range__iterator.xml]
[section:segment_range_iterator segment_range_iterator]
+Iterator which adapts a segment (two points) as iterator.
+
[heading Synopsis]
``template<typename Segment>
class segment_range_iterator
Modified: trunk/libs/geometry/doc/reference/set.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/set.qbk (original)
+++ trunk/libs/geometry/doc/reference/set.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__set.xml]
[section:set set]
Modified: trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk (original)
+++ trunk/libs/geometry/doc/reference/side_side_by_cross_track.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1side_1_1side__by__cross__track.xml]
[section:strategy_side_side_by_cross_track strategy::side::side_by_cross_track]
+Check at which side of a segment a point lies:
+
[heading Description]
from a Great Circle segment between two points: left of segment (> 0), right of segment (< 0), on segment (0)
Modified: trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk (original)
+++ trunk/libs/geometry/doc/reference/side_side_by_triangle.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1side_1_1side__by__triangle.xml]
[section:strategy_side_side_by_triangle strategy::side::side_by_triangle]
+Check at which side of a segment a point lies:
+
[heading Description]
left of segment (> 0), right of segment (< 0), on segment (0) In fact this is twice the area of a triangle
Modified: trunk/libs/geometry/doc/reference/simplify.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/simplify.qbk (original)
+++ trunk/libs/geometry/doc/reference/simplify.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__simplify.xml]
[section:simplify_3 simplify]
Modified: trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk (original)
+++ trunk/libs/geometry/doc/reference/simplify_douglas_peucker.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,14 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1simplify_1_1douglas__peucker.xml]
[section:strategy_simplify_douglas_peucker strategy::simplify::douglas_peucker]
+Implements the simplify algorithm.
+
[heading Description]
-The
+The douglas_peucker strategy simplifies a linestring, ring or vector of points using the well-known Douglas-Peucker algorithm. For the algorithm, see for example:
[heading Synopsis]
``template<typename Point, typename PointDistanceStrategy>
Modified: trunk/libs/geometry/doc/reference/spherical.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/spherical.qbk (original)
+++ trunk/libs/geometry/doc/reference/spherical.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1cs_1_1spherical.xml]
[section:cs_spherical cs::spherical]
+Spherical coordinate system, in degree or in radian.
+
[heading Description]
Defines the spherical coordinate system where points are defined in two angles and an optional radius usually known as r, theta, phi
Modified: trunk/libs/geometry/doc/reference/sym_difference.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/sym_difference.qbk (original)
+++ trunk/libs/geometry/doc/reference/sym_difference.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__sym__difference.xml]
[section:sym_difference sym_difference]
Modified: trunk/libs/geometry/doc/reference/tag.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/tag.qbk (original)
+++ trunk/libs/geometry/doc/reference/tag.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,12 +11,14 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1tag.xml]
[section:tag tag]
+Meta-function to get the tag of any geometry type.
+
[heading Description]
-All geometries tell their geometry type (point, linestring, polygon, etc) by implementing a tag traits class. This meta-function uses that traits class to retrieve the tag. If the input type is not a geometry at all, a
+All geometries tell their geometry type (point, linestring, polygon, etc) by implementing a tag traits class. This meta-function uses that traits class to retrieve the tag. If the input type is not a geometry at all, a geometry_not_recognized_tag will be returned.
[heading Synopsis]
``template<typename Geometry>
Modified: trunk/libs/geometry/doc/reference/topological_dimension.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/topological_dimension.qbk (original)
+++ trunk/libs/geometry/doc/reference/topological_dimension.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/structboost_1_1geometry_1_1topological__dimension.xml]
[section:topological_dimension topological_dimension]
+Meta-function returning the topological dimension of a geometry.
+
[heading Description]
The topological dimension defines a point as 0-dimensional, a linestring as 1-dimensional, and a ring or polygon as 2-dimensional.
Modified: trunk/libs/geometry/doc/reference/transform.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__transform.xml]
[section:transform_2 transform]
Modified: trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_inverse_transformer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1inverse__transformer.xml]
[section:strategy_transform_inverse_transformer strategy::transform::inverse_transformer]
+Transformation strategy to do an inverse ransformation in Cartesian system.
+
[heading Synopsis]
``template<typename P1, typename P2>
class strategy::transform::inverse_transformer
Modified: trunk/libs/geometry/doc/reference/transform_map_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_map_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_map_transformer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer.xml]
[section:strategy_transform_map_transformer strategy::transform::map_transformer]
+Transformation strategy to do map from one to another Cartesian system.
+
[heading Synopsis]
``template<typename P1, typename P2, bool Mirror, bool SameScale, std::size_t Dimension1, std::size_t Dimension2>
class strategy::transform::map_transformer
Modified: trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_rotate_transformer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1rotate__transformer.xml]
[section:strategy_transform_rotate_transformer strategy::transform::rotate_transformer]
+Strategy of rotate transformation in Cartesian system.
+
[heading Description]
Rotate rotates a geometry of specified angle about a fixed point (e.g. origin).
Modified: trunk/libs/geometry/doc/reference/transform_scale_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_scale_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_scale_transformer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1scale__transformer.xml]
[section:strategy_transform_scale_transformer strategy::transform::scale_transformer]
+Strategy of scale transformation in Cartesian system.
+
[heading Description]
Scale scales a geometry up or down in all its dimensions.
Modified: trunk/libs/geometry/doc/reference/transform_translate_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_translate_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_translate_transformer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1translate__transformer.xml]
[section:strategy_transform_translate_transformer strategy::transform::translate_transformer]
+Strategy of translate transformation in Cartesian system.
+
[heading Description]
Translate moves a geometry a fixed distance in 2 or 3 dimensions.
Modified: trunk/libs/geometry/doc/reference/transform_ublas_transformer.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/transform_ublas_transformer.qbk (original)
+++ trunk/libs/geometry/doc/reference/transform_ublas_transformer.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1transform_1_1ublas__transformer.xml]
[section:strategy_transform_ublas_transformer strategy::transform::ublas_transformer]
+Affine transformation strategy in Cartesian system.
+
[heading Description]
The strategy serves as a generic definition of affine transformation matrix and procedure of application it to given point.
Modified: trunk/libs/geometry/doc/reference/union.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/union.qbk (original)
+++ trunk/libs/geometry/doc/reference/union.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__union.xml]
[section:union_ union_]
Modified: trunk/libs/geometry/doc/reference/unique.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/unique.qbk (original)
+++ trunk/libs/geometry/doc/reference/unique.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__unique.xml]
[section:unique unique]
Modified: trunk/libs/geometry/doc/reference/within.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within.qbk (original)
+++ trunk/libs/geometry/doc/reference/within.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,7 +11,7 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/group__within.xml]
[section:within_3_with_strategy within (with strategy)]
Modified: trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk (original)
+++ trunk/libs/geometry/doc/reference/within_crossings_multiply.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1within_1_1crossings__multiply.xml]
[section:strategy_within_crossings_multiply strategy::within::crossings_multiply]
+Within detection using cross counting,.
+
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType>
class strategy::within::crossings_multiply
Modified: trunk/libs/geometry/doc/reference/within_franklin.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within_franklin.qbk (original)
+++ trunk/libs/geometry/doc/reference/within_franklin.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1within_1_1franklin.xml]
[section:strategy_within_franklin strategy::within::franklin]
+Within detection using cross counting.
+
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType>
class strategy::within::franklin
Modified: trunk/libs/geometry/doc/reference/within_winding.qbk
==============================================================================
--- trunk/libs/geometry/doc/reference/within_winding.qbk (original)
+++ trunk/libs/geometry/doc/reference/within_winding.qbk 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -11,10 +11,12 @@
=============================================================================/]
-[/ Generated by doxygen_xml2qbk, don't change, it will be overwritten automatically]
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from doxy/doxygen_output/xml/classboost_1_1geometry_1_1strategy_1_1within_1_1winding.xml]
[section:strategy_within_winding strategy::within::winding]
+Within detection using winding rule.
+
[heading Synopsis]
``template<typename Point, typename PointOfSegment, typename CalculationType>
class strategy::within::winding
Modified: trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_elements.hpp
==============================================================================
--- trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_elements.hpp (original)
+++ trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_elements.hpp 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -31,7 +31,10 @@
markup(int c = 0, std::string const& v = "")
: code(c)
, value(v)
- {}
+ {
+ boost::trim(value);
+ boost::replace_all(value, "\\*", "*");
+ }
};
Modified: trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp
==============================================================================
--- trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp (original)
+++ trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -109,7 +109,7 @@
std::string xml_string = file_to_string(filename);
std::string license = copyright_filename.empty()
? ""
- : file_to_string(copyright_filename, true);
+ : file_to_string(copyright_filename);
// Parse the XML outputted by Doxygen
xml_doc xml(xml_string.c_str());
Modified: trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/file_to_string.hpp
==============================================================================
--- trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/file_to_string.hpp (original)
+++ trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/file_to_string.hpp 2011-01-22 12:36:56 EST (Sat, 22 Jan 2011)
@@ -13,10 +13,8 @@
#include <string>
#include <fstream>
-#include <boost/algorithm/string.hpp>
-
-inline std::string file_to_string(std::string const& filename, bool add_nl = false)
+inline std::string file_to_string(std::string const& filename)
{
std::string result;
@@ -27,14 +25,7 @@
{
std::string line;
std::getline(cpp_file, line);
- boost::trim(line);
-
- result += line;
-
- if (add_nl)
- {
- result += "\n";
- }
+ result += line + "\n";
}
}
return result;
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