Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r67444 - in sandbox/geometry: boost/geometry/algorithms boost/geometry/algorithms/detail/overlay libs/geometry/doc libs/geometry/doc/doxygen_input/pages
From: barend.gehrels_at_[hidden]
Date: 2010-12-24 09:19:09

Author: barendgehrels
Date: 2010-12-24 09:19:00 EST (Fri, 24 Dec 2010)
New Revision: 67444
URL: http://svn.boost.org/trac/boost/changeset/67444

Log:
Update for quickbook/doxygen
Text files modified:
   sandbox/geometry/boost/geometry/algorithms/detail/overlay/enrich_intersection_points.hpp | 1 +
   sandbox/geometry/boost/geometry/algorithms/num_points.hpp | 1 +
   sandbox/geometry/libs/geometry/doc/Doxyfile | 2 +-
   sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_examples.hpp | 12 ------------
   sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_pages.hpp | 29 ++++++++++++++++++++---------
   5 files changed, 23 insertions(+), 22 deletions(-)

Modified: sandbox/geometry/boost/geometry/algorithms/detail/overlay/enrich_intersection_points.hpp
==============================================================================
--- sandbox/geometry/boost/geometry/algorithms/detail/overlay/enrich_intersection_points.hpp (original)
+++ sandbox/geometry/boost/geometry/algorithms/detail/overlay/enrich_intersection_points.hpp 2010-12-24 09:19:00 EST (Fri, 24 Dec 2010)
@@ -424,6 +424,7 @@
\tparam Geometry2 \tparam_geometry
\tparam Strategy side strategy type
\param turn_points container containing intersectionpoints
+\param for_operation operation_type (union or intersection)
\param geometry1 \param_geometry
\param geometry2 \param_geometry
\param strategy strategy

Modified: sandbox/geometry/boost/geometry/algorithms/num_points.hpp
==============================================================================
--- sandbox/geometry/boost/geometry/algorithms/num_points.hpp (original)
+++ sandbox/geometry/boost/geometry/algorithms/num_points.hpp 2010-12-24 09:19:00 EST (Fri, 24 Dec 2010)
@@ -144,6 +144,7 @@
\details \details_calc{num_points, number of points}.
\tparam Geometry \tparam_geometry
\param geometry \param_geometry
+\param add_for_open add one for open geometries (i.e. polygon types which are not closed)
\return \return_calc{number of points}

\qbk{behavior,__point__:[qbk_ret 1]}

Modified: sandbox/geometry/libs/geometry/doc/Doxyfile
==============================================================================
--- sandbox/geometry/libs/geometry/doc/Doxyfile (original)
+++ sandbox/geometry/libs/geometry/doc/Doxyfile 2010-12-24 09:19:00 EST (Fri, 24 Dec 2010)
@@ -185,7 +185,7 @@
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
-EXAMPLE_PATH = . .. ../example \
+EXAMPLE_PATH = . .. ../example ../example/with_external_libs \
                         doxygen_input/sourcecode \
                         ../../../boost/geometry/geometries \
                         ../../../boost/geometry/strategies \

Modified: sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_examples.hpp
==============================================================================
--- sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_examples.hpp (original)
+++ sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_examples.hpp 2010-12-24 09:19:00 EST (Fri, 24 Dec 2010)
@@ -201,18 +201,6 @@
*/

-//---------------------------------------------------------------------------------------------------
- /*!
-\example x02_numeric_adaptor_example.cpp
-
-The Numeric Adaptor is recently introduced to the Boost mailing list It is a proxy to high precision
-arithmetic libraries such as GMP or CLN.
-However, it might be that the same effect can be used using the Boost.Math bindings.
-
-This example shows how the GGL can be combined with non-numeric value types such as
-from the Numeric Adaptor
-\image html x02_numeric_adaptor_example_output.png
-*/

Modified: sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_pages.hpp
==============================================================================
--- sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_pages.hpp (original)
+++ sandbox/geometry/libs/geometry/doc/doxygen_input/pages/doxygen_pages.hpp 2010-12-24 09:19:00 EST (Fri, 24 Dec 2010)
@@ -220,6 +220,17 @@

*/

+// BSG 24-12-2010: re-added to silence Doxygen warnings:
+/*!
+\page WKT WKT (Well-Known Text)
+WKT is a textual representation of a geometry, explained here: http://en.wikipedia.org/wiki/Well-known_text
+WKT can represent a point, a linestring, a polygon, or multi versions of those.
+
+It is currently just a utility in the library, used in samples and tests, to get some textual output
+of a geometry.
+
+*/
+
//---------------------------------------------------------------------------------------------------

@@ -241,22 +252,22 @@
\section Classes
OGC defines the following geometry classes,
which are implemented as concepts (and as geometries) in the Generic Geometry Library:
-- \ref boost::geometry::point "point": a point. The point defined here is dimensionally agnostic.
+- \ref boost::geometry::model::point "point": a point. The point defined here is dimensionally agnostic.
Library users does not have to use this point, they might also use their own points as long as it meets the concepts.
-- \ref boost::geometry::linestring "linestring": Sequence of point values with linear interpolation
+- \ref boost::geometry::model::linestring "linestring": Sequence of point values with linear interpolation
between points. Note that library users does not have to use this type. Algorithms works on iterators, so
all algorithms also accept iterators on a vector (or other container) of points.
-- \ref boost::geometry::linear_ring "linear_ring": Sequence of point values with linear interpolation
+- \ref boost::geometry::model::linear_ring "linear_ring": Sequence of point values with linear interpolation
between points, which is closed and not self-intersecting
-- \ref boost::geometry::polygon "polygon": Plane figure, consisting of an outer ring and zero or more
+- \ref boost::geometry::model::polygon "polygon": Plane figure, consisting of an outer ring and zero or more
inner rings. So basically a polygon which might have holes.
<em>Note that this definition is different from several other polygon definitions and libraries,
where polygons are not allowed to have holes. These polygons are comparable to the linear_ring above</em>

And multi-geometries:
-- \ref boost::geometry::multi_point "multi_point": collection of points
-- \ref boost::geometry::multi_linestring "multi_linestring": collection of linestrings
-- \ref boost::geometry::multi_polygon "multi_polygon": collection of polygons
+- \ref boost::geometry::model::multi_point "multi_point": collection of points
+- \ref boost::geometry::model::multi_linestring "multi_linestring": collection of linestrings
+- \ref boost::geometry::model::multi_polygon "multi_polygon": collection of polygons

The naming of these classes is used in:
- WKT (Well-Known Text)
@@ -272,8 +283,8 @@
- MonetDB

Besides this the Generic Geometry Library provides the following additional classes:
-- \ref boost::geometry::box "box": Box, used for selections and for envelopes (bounding boxes)
-- \ref boost::geometry::segment "segment": Segment, helper class, used for e.g. intersections
+- \ref boost::geometry::model::box "box": Box, used for selections and for envelopes (bounding boxes)
+- \ref boost::geometry::model::segment "segment": Segment, helper class, used for e.g. intersections

Finally geometry types can be added as extensions. This is e.g. done with an
"n-sphere" meaning "circle" and "sphere". Circle is convenient for selections.

Date view	Thread view	Subject view	Author view

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