|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r82435 - in sandbox-branches/geometry/index/doc: generated html html/geometry_index/r_tree src/tools/doxygen_xml2qbk
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-10 15:12:42
Author: awulkiew
Date: 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
New Revision: 82435
URL: http://svn.boost.org/trac/boost/changeset/82435
Log:
doxygen_xml2qbk fixed brackets display in sections titles and generated tables.
Text files modified:
sandbox-branches/geometry/index/doc/generated/adaptors.qbk | 15 +-
sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk | 35 ++++--
sandbox-branches/geometry/index/doc/generated/inserters.qbk | 5
sandbox-branches/geometry/index/doc/generated/predicates.qbk | 35 ++++--
sandbox-branches/geometry/index/doc/generated/rtree.qbk | 151 +++++++++++++++++-----------
sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk | 75 ++++++++-----
sandbox-branches/geometry/index/doc/generated/translator_index.qbk | 6
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 204 ---------------------------------------
sandbox-branches/geometry/index/doc/html/index.html | 2
sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp | 58 ++++++----
10 files changed, 230 insertions(+), 356 deletions(-)
Modified: sandbox-branches/geometry/index/doc/generated/adaptors.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/adaptors.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/adaptors.qbk 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -9,7 +9,9 @@
]
[section:function0 nearest_queried(DistancesPredicates const &, size_t, Predicates const &)]
-The nearest query index adaptor generator. [heading Synopsis]
+The nearest query index adaptor generator.
+
+[heading Synopsis]
``template<typename DistancesPredicates, typename Predicates>
detail::nearest_query<DistancesPredicates, Predicates> boost::geometry::index::adaptors::nearest_queried(DistancesPredicates const & dpred,
size_t k,
@@ -23,10 +25,11 @@
[[ `Predicates const &` ][ `pred` ][Spatial predicates. ]]
]
[endsect]
-[br]
[section:function1 nearest_queried(DistancesPredicates const &, size_t)]
-The nearest query index adaptor generator. [heading Synopsis]
+The nearest query index adaptor generator.
+
+[heading Synopsis]
``template<typename DistancesPredicates>
detail::nearest_query<DistancesPredicates, index::detail::empty> boost::geometry::index::adaptors::nearest_queried(DistancesPredicates const & dpred, size_t k)``
@@ -37,10 +40,11 @@
[[ `size_t` ][ `k` ][The number of values to find. ]]
]
[endsect]
-[br]
[section:function2 spatial_queried(Predicates const &)]
-The spatial query index adaptor generator. [heading Synopsis]
+The spatial query index adaptor generator.
+
+[heading Synopsis]
``template<typename Predicates>
detail::spatial_query<Predicates> boost::geometry::index::adaptors::spatial_queried(Predicates const & pred)``
@@ -50,7 +54,6 @@
[[ `Predicates const &` ][ `pred` ][Spatial predicates. ]]
]
[endsect]
-[br]
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/distance_predicates.qbk 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -13,7 +13,9 @@
]
[section:function0 to_nearest(T const &)]
-Generate to_nearest() Point-Indexable relationship. [heading Description]
+Generate to_nearest() Point-Indexable relationship.
+
+[heading Description]
Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances as smallest as possible between query Point and Indexable's points. In other words it should be the distance to the nearest Indexable's point. This function may be also used to define distances bounds which indicates that Indexable's nearest point should be closer or further than value v. This is default relation.[heading Synopsis]
``template<typename T>
detail::to_nearest<T> boost::geometry::index::to_nearest(T const & v)``
@@ -24,10 +26,11 @@
[[ `T const &` ][ `v` ][Point or bound value. ]]
]
[endsect]
-[br]
[section:function1 to_centroid(T const &)]
-Generate to_centroid() Point-Indexable relationship. [heading Description]
+Generate to_centroid() Point-Indexable relationship.
+
+[heading Description]
Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances between query Point and Indexable's centroid. This function may be also used to define distances bounds which indicates that Indexable's centroid should be closer or further than value v.[heading Synopsis]
``template<typename T>
detail::to_centroid<T> boost::geometry::index::to_centroid(T const & v)``
@@ -38,10 +41,11 @@
[[ `T const &` ][ `v` ][Point or bound value. ]]
]
[endsect]
-[br]
[section:function2 to_furthest(T const &)]
-Generate to_furthest() Point-Indexable relationship. [heading Description]
+Generate to_furthest() Point-Indexable relationship.
+
+[heading Description]
Generate a nearest query Point and Value's Indexable relationship while calculating distances. This function may be used to define that knn query should calculate distances as biggest as possible between query Point and Indexable's points. In other words it should be the distance to the furthest Indexable's point. This function may be also used to define distances bounds which indicates that Indexable's furthest point should be closer or further than value v.[heading Synopsis]
``template<typename T>
detail::to_furthest<T> boost::geometry::index::to_furthest(T const & v)``
@@ -52,10 +56,11 @@
[[ `T const &` ][ `v` ][Point or bound value. ]]
]
[endsect]
-[br]
[section:function3 unbounded(PointRelation const &)]
-Generate unbounded() distance predicate. [heading Description]
+Generate unbounded() distance predicate.
+
+[heading Description]
Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that there is no distance bounds and Values should be returned if distances between Point and Indexable are the smallest. Distance calculation is defined by PointRelation. This is default nearest predicate.[heading Synopsis]
``template<typename PointRelation>
detail::unbounded<PointRelation> boost::geometry::index::unbounded(PointRelation const & pr)``
@@ -66,10 +71,11 @@
[[ `PointRelation const &` ][ `pr` ][The point relation. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). ]]
]
[endsect]
-[br]
[section:function4 min_bounded(PointRelation const &, MinRelation const &)]
-Generate min_bounded() distance predicate. [heading Description]
+Generate min_bounded() distance predicate.
+
+[heading Description]
Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are greater or equal to some min_distance passed in MinRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are further than some distance.[heading Synopsis]
``template<typename PointRelation, typename MinRelation>
detail::min_bounded<PointRelation, MinRelation> boost::geometry::index::min_bounded(PointRelation const & pr, MinRelation const & minr)``
@@ -81,10 +87,11 @@
[[ `MinRelation const &` ][ `minr` ][The minimum bound relation. This may be generated by bgi::to_nearest(min_distance), bgi::to_centroid(min_distance) or bgi::to_furthest(min_distance). ]]
]
[endsect]
-[br]
[section:function5 max_bounded(PointRelation const &, MaxRelation const &)]
-Generate max_bounded() distance predicate. [heading Description]
+Generate max_bounded() distance predicate.
+
+[heading Description]
Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are lesser or equal to some max_distance passed in MaxRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are closer than some distance.[heading Synopsis]
``template<typename PointRelation, typename MaxRelation>
detail::max_bounded<PointRelation, MaxRelation> boost::geometry::index::max_bounded(PointRelation const & pr, MaxRelation const & maxr)``
@@ -96,10 +103,11 @@
[[ `MaxRelation const &` ][ `maxr` ][The maximum bound relation. This may be generated by bgi::to_nearest(max_distance), bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance). ]]
]
[endsect]
-[br]
[section:function6 bounded(PointRelation const &, MinRelation const &, MaxRelation const &)]
-Generate bounded() distance predicate. [heading Description]
+Generate bounded() distance predicate.
+
+[heading Description]
Generate a distance predicate. This defines distances bounds which are used by knn query. This function indicates that Values should be returned only if distances between Point and Indexable are greater or equal to some min_distance passed in MinRelation and lesser or equal to some max_distance passed in MaxRelation. Check for closest Value is defined by PointRelation. So it is possible e.g. to return Values with centroids closest to some Point but only if nearest points are further than some distance and closer than some other distance.[heading Synopsis]
``template<typename PointRelation,
typename MinRelation,
@@ -116,7 +124,6 @@
[[ `MaxRelation const &` ][ `maxr` ][The maximum bound relation. This may be generated by bgi::to_nearest(max_distance), bgi::to_centroid(max_distance) or bgi::to_furthest(max_distance). ]]
]
[endsect]
-[br]
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/inserters.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/inserters.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/inserters.qbk 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -7,7 +7,9 @@
]
[section:function0 inserter(Container &)]
-Insert iterator generator. [heading Description]
+Insert iterator generator.
+
+[heading Description]
Returns insert iterator capable to insert values to the container (spatial index) which has member function insert(value_type const&) defined.[heading Synopsis]
``template<typename Container>
insert_iterator<Container> boost::geometry::index::inserter(Container & c)``
@@ -20,7 +22,6 @@
[heading Returns]
The insert iterator inserting values to the container.
[endsect]
-[br]
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/predicates.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/predicates.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/predicates.qbk 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -13,14 +13,17 @@
]
[section:function0 empty()]
-Generate empty predicate. [heading Synopsis]
+Generate empty predicate.
+
+[heading Synopsis]
``detail::empty boost::geometry::index::empty()``
[endsect]
-[br]
[section:function1 value(ValuePredicate const &)]
-Generate value predicate. [heading Description]
+Generate value predicate.
+
+[heading Description]
A wrapper around user-defined functor describing if Value should be returned by spatial query.[heading Synopsis]
``template<typename ValuePredicate>
detail::value<ValuePredicate> boost::geometry::index::value(ValuePredicate const & vpred)``
@@ -31,10 +34,11 @@
[[ `ValuePredicate const &` ][ `vpred` ][The functor. ]]
]
[endsect]
-[br]
[section:function2 covered_by(Geometry const &)]
-Generate covered_by() predicate. [heading Description]
+Generate covered_by() predicate.
+
+[heading Description]
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::covered_by(Indexable, Geometry) returns true.[heading Synopsis]
``template<typename Geometry>
detail::covered_by<Geometry> boost::geometry::index::covered_by(Geometry const & g)``
@@ -45,10 +49,11 @@
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
]
[endsect]
-[br]
[section:function3 disjoint(Geometry const &)]
-Generate disjoint() predicate. [heading Description]
+Generate disjoint() predicate.
+
+[heading Description]
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::disjoint(Indexable, Geometry) returns true.[heading Synopsis]
``template<typename Geometry>
detail::disjoint<Geometry> boost::geometry::index::disjoint(Geometry const & g)``
@@ -59,10 +64,11 @@
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
]
[endsect]
-[br]
[section:function4 intersects(Geometry const &)]
-Generate intersects() predicate. [heading Description]
+Generate intersects() predicate.
+
+[heading Description]
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::intersects(Indexable, Geometry) returns true.[heading Synopsis]
``template<typename Geometry>
detail::intersects<Geometry> boost::geometry::index::intersects(Geometry const & g)``
@@ -73,10 +79,11 @@
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
]
[endsect]
-[br]
[section:function5 overlaps(Geometry const &)]
-Generate overlaps() predicate. [heading Description]
+Generate overlaps() predicate.
+
+[heading Description]
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::overlaps(Indexable, Geometry) returns true.[heading Synopsis]
``template<typename Geometry>
detail::overlaps<Geometry> boost::geometry::index::overlaps(Geometry const & g)``
@@ -87,10 +94,11 @@
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
]
[endsect]
-[br]
[section:function6 within(Geometry const &)]
-Generate within() predicate. [heading Description]
+Generate within() predicate.
+
+[heading Description]
Generate a predicate defining Value and Geometry relationship. Value will be returned by the query if bg::within(Indexable, Geometry) returns true.[heading Synopsis]
``template<typename Geometry>
detail::within<Geometry> boost::geometry::index::within(Geometry const & g)``
@@ -101,7 +109,6 @@
[[ `Geometry const &` ][ `g` ][The Geometry object. ]]
]
[endsect]
-[br]
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/rtree.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree.qbk 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -88,9 +88,10 @@
[[[link geometry_index.r_tree.reference.boost_geometry_index_rtree.member29 `get_allocator()`]][Returns allocator used by the rtree. ]]
]
-[br]
[section:member0 rtree()]
-The constructor. [heading Synopsis]
+The constructor.
+
+[heading Synopsis]
``rtree(parameters_type parameters = parameters_type(), translator_type const & translator = translator_type())``
[heading Parameters]
@@ -103,10 +104,11 @@
If allocator default constructor throws.
[endsect]
-[br]
[section:member1 rtree(parameters_type, translator_type const &, allocator_type)]
-The constructor. [heading Synopsis]
+The constructor.
+
+[heading Synopsis]
``rtree(parameters_type parameters,
translator_type const & translator,
allocator_type allocator)``
@@ -122,10 +124,11 @@
If allocator copy constructor throws.
[endsect]
-[br]
[section:member2 rtree(Iterator, Iterator)]
-The constructor. [heading Synopsis]
+The constructor.
+
+[heading Synopsis]
``template<typename Iterator>
rtree(Iterator first,
Iterator last,
@@ -146,10 +149,11 @@
If allocator copy constructor throws. If Value copy constructor or copy assignment throws. When nodes allocation fails.
[endsect]
-[br]
[section:member3 rtree(Range const &)]
-The constructor. [heading Synopsis]
+The constructor.
+
+[heading Synopsis]
``template<typename Range>
rtree(Range const & rng,
parameters_type parameters = parameters_type(),
@@ -168,20 +172,22 @@
If allocator copy constructor throws. If Value copy constructor or copy assignment throws. When nodes allocation fails.
[endsect]
-[br]
[section:member4 ~rtree()]
-The destructor. [heading Synopsis]
+The destructor.
+
+[heading Synopsis]
``~rtree()``
[heading Throws]
Nothing.
[endsect]
-[br]
[section:member5 rtree(rtree const &)]
-The copy constructor. [heading Description]
+The copy constructor.
+
+[heading Description]
It uses parameters, translator and allocator from the source tree.[heading Synopsis]
``rtree(rtree const & src)``
@@ -194,10 +200,11 @@
If allocator copy constructor throws. If Value copy constructor throws. When nodes allocation fails.
[endsect]
-[br]
[section:member6 rtree(rtree const &, allocator_type const &)]
-The copy constructor. [heading Description]
+The copy constructor.
+
+[heading Description]
It uses Parameters and translator from the source tree.[heading Synopsis]
``rtree(rtree const & src, allocator_type const & allocator)``
@@ -211,10 +218,11 @@
If allocator copy constructor throws. If Value copy constructor throws. When nodes allocation fails.
[endsect]
-[br]
[section:member7 rtree(rtree &&)]
-The moving constructor. [heading Description]
+The moving constructor.
+
+[heading Description]
It uses parameters, translator and allocator from the source tree.[heading Synopsis]
``rtree(rtree && src)``
@@ -227,10 +235,11 @@
If allocator move constructor throws.
[endsect]
-[br]
[section:member8 operator=(const rtree &)]
-The assignment operator. [heading Description]
+The assignment operator.
+
+[heading Description]
It uses parameters and translator from the source tree.[heading Synopsis]
``rtree & operator=(const rtree & src)``
@@ -243,10 +252,11 @@
If Value copy constructor throws. When nodes allocation fails.
[endsect]
-[br]
[section:member9 operator=(rtree &&)]
-The moving assignment. [heading Description]
+The moving assignment.
+
+[heading Description]
It uses parameters and translator from the source tree.[heading Synopsis]
``rtree & operator=(rtree && src)``
@@ -259,10 +269,11 @@
Only if allocators aren't equal. If Value copy constructor throws. When nodes allocation fails.
[endsect]
-[br]
[section:member10 swap(rtree &)]
-Swaps contents of two rtrees. [heading Description]
+Swaps contents of two rtrees.
+
+[heading Description]
Parameters, translator and allocators are swapped as well.[heading Synopsis]
``void swap(rtree & other)``
@@ -275,10 +286,11 @@
If allocators swap throws.
[endsect]
-[br]
[section:member11 insert(value_type const &)]
-Insert a value to the index. [heading Synopsis]
+Insert a value to the index.
+
+[heading Synopsis]
``void insert(value_type const & value)``
[heading Parameters]
@@ -292,10 +304,11 @@
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
[endsect]
-[br]
[section:member12 insert(Iterator, Iterator)]
-Insert a range of values to the index. [heading Synopsis]
+Insert a range of values to the index.
+
+[heading Synopsis]
``template<typename Iterator>
void insert(Iterator first, Iterator last)``
@@ -311,10 +324,11 @@
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
[endsect]
-[br]
[section:member13 insert(Range const &)]
-Insert a range of values to the index. [heading Synopsis]
+Insert a range of values to the index.
+
+[heading Synopsis]
``template<typename Range>
void insert(Range const & rng)``
@@ -329,10 +343,11 @@
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
[endsect]
-[br]
[section:member14 remove(value_type const &)]
-Remove a value from the container. [heading Description]
+Remove a value from the container.
+
+[heading Description]
In contrast to the STL set/map erase() method this method removes only one value from the container.[heading Synopsis]
``size_type remove(value_type const & value)``
@@ -349,10 +364,11 @@
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
[endsect]
-[br]
[section:member15 remove(Iterator, Iterator)]
-Remove a range of values from the container. [heading Description]
+Remove a range of values from the container.
+
+[heading Description]
In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.[heading Synopsis]
``template<typename Iterator>
size_type remove(Iterator first, Iterator last)``
@@ -371,10 +387,11 @@
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
[endsect]
-[br]
[section:member16 remove(Range const &)]
-Remove a range of values from the container. [heading Description]
+Remove a range of values from the container.
+
+[heading Description]
In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore, this method removes only one value for each one passed in the range, not all equal values.[heading Synopsis]
``template<typename Range>
size_type remove(Range const & rng)``
@@ -392,10 +409,11 @@
This operation is not thread safe. If it throws, the R-tree may be left in an inconsistent state, elements must not be inserted or removed, methods may return invalid data.
[endsect]
-[br]
[section:member17 spatial_query(Predicates const &, OutIter)]
-Finds values meeting spatial predicates, e.g. intersecting some Box. [heading Description]
+Finds values meeting spatial predicates, e.g. intersecting some Box.
+
+[heading Description]
Spatial predicates may be a Geometry (in this case default predicate - intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func). Those predicates may be passed together in std::pair or boost::tuple.[heading Synopsis]
``template<typename Predicates, typename OutIter>
size_type spatial_query(Predicates const & pred, OutIter out_it)``
@@ -412,10 +430,11 @@
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
-[br]
[section:member18 nearest_query(DistancesPredicates const &, value_type &)]
-Finds one value meeting distances predicates, e.g. nearest to some Point. [heading Description]
+Finds one value meeting distances predicates, e.g. nearest to some Point.
+
+[heading Description]
The distances predicates may be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).[heading Synopsis]
``template<typename DistancesPredicates>
size_type nearest_query(DistancesPredicates const & dpred, value_type & v)``
@@ -432,10 +451,11 @@
If Value copy constructor or copy assignment throws.
[endsect]
-[br]
[section:member19 nearest_query(DistancesPredicates const &, Predicates const &, value_type &)]
-Finds one value meeting distances predicates and spatial predicates, e.g. nearest to some Point and intersecting some Box. [heading Description]
+Finds one value meeting distances predicates and spatial predicates, e.g. nearest to some Point and intersecting some Box.
+
+[heading Description]
The distances predicates may be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).
The spatial predicates. May be a Geometry (in this case default predicate - intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func). Those predicates may be passed together in std::pair or boost::tuple.[heading Synopsis]
@@ -457,10 +477,11 @@
If Value copy constructor or copy assignment throws.
[endsect]
-[br]
[section:member20 nearest_query(DistancesPredicates const &, size_t, OutIter)]
-Finds k values meeting distances predicates, e.g. k nearest values to some Point. [heading Description]
+Finds k values meeting distances predicates, e.g. k nearest values to some Point.
+
+[heading Description]
The distances predicates. May be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).[heading Synopsis]
``template<typename DistancesPredicates, typename OutIter>
size_type nearest_query(DistancesPredicates const & dpred,
@@ -480,10 +501,11 @@
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
-[br]
[section:member21 nearest_query(DistancesPredicates const &, size_t, Predicates const &, OutIter)]
-Finds k values meeting distances predicates and spatial predicates, e.g. k nearest values to some Point and intersecting some Box. [heading Description]
+Finds k values meeting distances predicates and spatial predicates, e.g. k nearest values to some Point and intersecting some Box.
+
+[heading Description]
The distances predicates may be a Point. This is default case where Value which nearest point is closest to Point is returned. May be a PointRelation which define how distance to Value is calculated. This may be generated by bgi::to_nearest(Point), bgi::to_centroid(Point) or bgi::to_furthest(Point). DistancesPredicates may also define distances bounds. E.g. that some distance must be between min_distance and max_distance. This may be generated by bgi::unbounded(PointRelation) - default case, bgi::min_bounded(PointRelation, MinRelation), bgi::max_bounded(PointRelation, MaxRelation), bgi::bounded(PointRelation, MinRelation, MaxRelation). MinRelation and MaxRelation describes bounds and may be generated by bgi::to_nearest(dist_bound), bgi::to_centroid(dist_bound) or bgi::to_furthest(dist_bound).
The spatial predicates. May be a Geometry (in this case default predicate - intersects is used) or generated by bgi::covered_by(geometry), bgi::disjoint(geometry), bgi::intersects(geometry), bgi::overlaps(geometry), bgi::within(geometry), !bgi::covered_by(geometry), !bgi::disjoint(geometry), !bgi::intersects(geometry), !bgi::overlaps(geometry), !bgi::within(geometry) or bgi::value(func). Those predicates may be passed together in std::pair or boost::tuple.[heading Synopsis]
@@ -509,10 +531,11 @@
If Value copy constructor or copy assignment throws. If OutIter dereference or increment throws.
[endsect]
-[br]
[section:member22 size()]
-Returns the number of stored values. [heading Synopsis]
+Returns the number of stored values.
+
+[heading Synopsis]
``size_type size()``
[heading Returns]
@@ -521,10 +544,11 @@
Nothing.
[endsect]
-[br]
[section:member23 empty()]
-Query if the container is empty. [heading Synopsis]
+Query if the container is empty.
+
+[heading Synopsis]
``bool empty()``
[heading Returns]
@@ -533,20 +557,22 @@
Nothing.
[endsect]
-[br]
[section:member24 clear()]
-Removes all values stored in the container. [heading Synopsis]
+Removes all values stored in the container.
+
+[heading Synopsis]
``void clear()``
[heading Throws]
Nothing.
[endsect]
-[br]
[section:member25 box()]
-Returns the box containing all values stored in the container. [heading Description]
+Returns the box containing all values stored in the container.
+
+[heading Description]
Returns the box containing all values stored in the container. If the container is empty the result of geometry::assign_inverse() is returned.[heading Synopsis]
``box_type box()``
@@ -556,10 +582,11 @@
Nothing.
[endsect]
-[br]
[section:member26 count(ValueOrIndexable const &)]
-Count Values or Indexables stored in the container. [heading Description]
+Count Values or Indexables stored in the container.
+
+[heading Description]
For indexable_type it returns the number of values which indexables equals the parameter. For value_type it returns the number of values which equals the parameter.[heading Synopsis]
``template<typename ValueOrIndexable>
size_type count(ValueOrIndexable const & vori)``
@@ -575,10 +602,11 @@
Nothing.
[endsect]
-[br]
[section:member27 parameters()]
-Returns parameters. [heading Synopsis]
+Returns parameters.
+
+[heading Synopsis]
``parameters_type const & parameters()``
[heading Returns]
@@ -587,10 +615,11 @@
Nothing.
[endsect]
-[br]
[section:member28 translator()]
-Returns the translator object. [heading Synopsis]
+Returns the translator object.
+
+[heading Synopsis]
``translator_type const & translator()``
[heading Returns]
@@ -599,10 +628,11 @@
Nothing.
[endsect]
-[br]
[section:member29 get_allocator()]
-Returns allocator used by the rtree. [heading Synopsis]
+Returns allocator used by the rtree.
+
+[heading Synopsis]
``allocator_type get_allocator()``
[heading Returns]
@@ -611,7 +641,6 @@
If allocator copy constructor throws.
[endsect]
-[br]
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/rtree_functions.qbk 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -21,7 +21,9 @@
]
[section:function0 insert(rtree<...> &, Value const &)]
-Insert a value to the index. [heading Synopsis]
+Insert a value to the index.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -35,10 +37,11 @@
[[ `Value const &` ][ `v` ][The value which will be stored in the index. ]]
]
[endsect]
-[br]
[section:function1 insert(rtree<...> &, Iterator, Iterator)]
-Insert a range of values to the index. [heading Synopsis]
+Insert a range of values to the index.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -56,10 +59,11 @@
[[ `Iterator` ][ `last` ][The end of the range of values. ]]
]
[endsect]
-[br]
[section:function2 insert(rtree<...> &, Range const &)]
-Insert a range of values to the index. [heading Synopsis]
+Insert a range of values to the index.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -74,10 +78,11 @@
[[ `Range const &` ][ `rng` ][The range of values. ]]
]
[endsect]
-[br]
[section:function3 remove(rtree<...> &, Value const &)]
-Remove a value from the container. [heading Description]
+Remove a value from the container.
+
+[heading Description]
Remove a value from the container. In contrast to the STL set/map erase() method this function removes only one value from the container.[heading Synopsis]
``template<typename Value,
typename Options,
@@ -94,10 +99,11 @@
[heading Returns]
1 if value was removed, 0 otherwise.
[endsect]
-[br]
[section:function4 remove(rtree<...> &, Iterator, Iterator)]
-Remove a range of values from the container. [heading Description]
+Remove a range of values from the container.
+
+[heading Description]
Remove a range of values from the container. In contrast to the STL set/map erase() method it doesn't take iterators pointing to values stored in this container. It removes values equal to these passed as a range. Furthermore this function removes only one value for each one passed in the range, not all equal values.[heading Synopsis]
``template<typename Value,
typename Options,
@@ -118,10 +124,11 @@
[heading Returns]
The number of removed values.
[endsect]
-[br]
[section:function5 remove(rtree<...> &, Range const &)]
-Remove a range of values from the container. [heading Description]
+Remove a range of values from the container.
+
+[heading Description]
Remove a range of values from the container. In contrast to the STL set/map erase() method it removes values equal to these passed as a range. Furthermore this method removes only one value for each one passed in the range, not all equal values.[heading Synopsis]
``template<typename Value,
typename Options,
@@ -139,10 +146,11 @@
[heading Returns]
The number of removed values.
[endsect]
-[br]
[section:function6 spatial_query(rtree<...> const &, Predicates const &, OutIter)]
-Find values meeting spatial predicates. [heading Synopsis]
+Find values meeting spatial predicates.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -163,10 +171,11 @@
[heading Returns]
The number of found values.
[endsect]
-[br]
[section:function7 nearest_query(rtree<...> const &, DistancesPredicates const &, Value &)]
-Find the value meeting distances predicates. [heading Synopsis]
+Find the value meeting distances predicates.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -186,10 +195,11 @@
[heading Returns]
The number of found values.
[endsect]
-[br]
[section:function8 nearest_query(rtree<...> const &, DistancesPredicates const &, Predicates const &, Value &)]
-Find the value meeting distances and spatial predicates. [heading Synopsis]
+Find the value meeting distances and spatial predicates.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -212,10 +222,11 @@
[heading Returns]
The number of found values.
[endsect]
-[br]
[section:function9 nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, OutIter)]
-Find k values meeting distances predicates. [heading Synopsis]
+Find k values meeting distances predicates.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -238,10 +249,11 @@
[heading Returns]
The number of found values.
[endsect]
-[br]
[section:function10 nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, Predicates const &, OutIter)]
-Find k values meeting distances and spatial predicates. [heading Synopsis]
+Find k values meeting distances and spatial predicates.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -267,10 +279,11 @@
[heading Returns]
The number of found values.
[endsect]
-[br]
[section:function11 clear(rtree<...> &)]
-Remove all values from the index. [heading Synopsis]
+Remove all values from the index.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -283,10 +296,11 @@
[[ `rtree< Value, Options, Translator, Allocator > &` ][ `tree` ][The spatial index. ]]
]
[endsect]
-[br]
[section:function12 size(rtree<...> const &)]
-Get the number of values stored in the index. [heading Synopsis]
+Get the number of values stored in the index.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -301,10 +315,11 @@
[heading Returns]
The number of values stored in the index.
[endsect]
-[br]
[section:function13 empty(rtree<...> const &)]
-Query if there are no values stored in the index. [heading Synopsis]
+Query if there are no values stored in the index.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -319,10 +334,11 @@
[heading Returns]
true if there are no values in the index.
[endsect]
-[br]
[section:function14 box(rtree<...> const &)]
-Get the box containing all stored values or an invalid box if the index has no values. [heading Synopsis]
+Get the box containing all stored values or an invalid box if the index has no values.
+
+[heading Synopsis]
``template<typename Value,
typename Options,
typename Translator,
@@ -337,7 +353,6 @@
[heading Returns]
The box containing all stored values or an invalid box.
[endsect]
-[br]
[endsect]
Modified: sandbox-branches/geometry/index/doc/generated/translator_index.qbk
==============================================================================
--- sandbox-branches/geometry/index/doc/generated/translator_index.qbk (original)
+++ sandbox-branches/geometry/index/doc/generated/translator_index.qbk 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -31,9 +31,10 @@
[[[link geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0 `index(Container const &)`]][The constructor. ]]
]
-[br]
[section:member0 index(Container const &)]
-The constructor. [heading Synopsis]
+The constructor.
+
+[heading Synopsis]
``index(Container const & c)``
[heading Parameters]
@@ -42,7 +43,6 @@
[[ `Container const &` ][ `c` ][The container which stores indexed values. ]]
]
[endsect]
-[br]
[endsect]
Modified: sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html (original)
+++ sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -45,7 +45,7 @@
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree" title="boost::geometry::index::rtree">boost::geometry::index::rtree</a>
</h4></div></div></div>
<p>
- <a class="indexterm" name="id886388"></a><a class="indexterm" name="id886392"></a><a class="indexterm" name="id886397"></a><a class="indexterm" name="id886402"></a>
+ <a class="indexterm" name="id899495"></a><a class="indexterm" name="id899500"></a><a class="indexterm" name="id899504"></a><a class="indexterm" name="id899509"></a>
The R-tree spatial index.
</p>
<h6>
@@ -729,9 +729,6 @@
</tr>
</tbody>
</table></div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member0" title="rtree()">rtree()</a>
@@ -820,9 +817,6 @@
If allocator default constructor throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member1" title="rtree(parameters_type, translator_type const &, allocator_type)">rtree(parameters_type,
@@ -931,9 +925,6 @@
If allocator copy constructor throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member2" title="rtree(Iterator, Iterator)">rtree(Iterator,
@@ -1080,9 +1071,6 @@
assignment throws. When nodes allocation fails.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member3" title="rtree(Range const &)">rtree(Range
@@ -1212,9 +1200,6 @@
assignment throws. When nodes allocation fails.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member4" title="~rtree()">~rtree()</a>
@@ -1239,9 +1224,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member5" title="rtree(rtree const &)">rtree(rtree
@@ -1321,9 +1303,6 @@
When nodes allocation fails.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member6" title="rtree(rtree const &, allocator_type const &)">rtree(rtree
@@ -1422,9 +1401,6 @@
When nodes allocation fails.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member7"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member7" title="rtree(rtree &&)">rtree(rtree
@@ -1502,9 +1478,6 @@
If allocator move constructor throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member8"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member8" title="operator=(const rtree &)">operator=(const
@@ -1583,9 +1556,6 @@
If Value copy constructor throws. When nodes allocation fails.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member9"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member9" title="operator=(rtree &&)">operator=(rtree
@@ -1664,9 +1634,6 @@
nodes allocation fails.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member10"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member10" title="swap(rtree &)">swap(rtree
@@ -1744,9 +1711,6 @@
If allocators swap throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member11"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member11" title="insert(value_type const &)">insert(value_type
@@ -1827,9 +1791,6 @@
may return invalid data.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member12"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member12" title="insert(Iterator, Iterator)">insert(Iterator,
@@ -1930,9 +1891,6 @@
may return invalid data.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member13"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member13" title="insert(Range const &)">insert(Range
@@ -2015,9 +1973,6 @@
may return invalid data.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member14"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member14" title="remove(value_type const &)">remove(value_type
@@ -2113,9 +2068,6 @@
may return invalid data.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member15"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member15" title="remove(Iterator, Iterator)">remove(Iterator,
@@ -2233,9 +2185,6 @@
may return invalid data.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member16"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member16" title="remove(Range const &)">remove(Range
@@ -2334,9 +2283,6 @@
may return invalid data.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member17"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member17" title="spatial_query(Predicates const &, OutIter)">spatial_query(Predicates
@@ -2448,9 +2394,6 @@
or increment throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member18"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member18" title="nearest_query(DistancesPredicates const &, value_type &)">nearest_query(DistancesPredicates
@@ -2566,9 +2509,6 @@
If Value copy constructor or copy assignment throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member19"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member19" title="nearest_query(DistancesPredicates const &, Predicates const &, value_type &)">nearest_query(DistancesPredicates
@@ -2712,9 +2652,6 @@
If Value copy constructor or copy assignment throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member20"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member20" title="nearest_query(DistancesPredicates const &, size_t, OutIter)">nearest_query(DistancesPredicates
@@ -2851,9 +2788,6 @@
or increment throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member21"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member21" title="nearest_query(DistancesPredicates const &, size_t, Predicates const &, OutIter)">nearest_query(DistancesPredicates
@@ -3018,9 +2952,6 @@
or increment throws.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member22"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member22" title="size()">size()</a>
@@ -3052,9 +2983,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member23"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member23" title="empty()">empty()</a>
@@ -3086,9 +3014,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member24"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member24" title="clear()">clear()</a>
@@ -3113,9 +3038,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member25"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member25" title="box()">box()</a>
@@ -3156,9 +3078,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member26"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member26" title="count(ValueOrIndexable const &)">count(ValueOrIndexable
@@ -3247,9 +3166,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member27"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member27" title="parameters()">parameters()</a>
@@ -3281,9 +3197,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member28"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member28" title="translator()">translator()</a>
@@ -3315,9 +3228,6 @@
Nothing.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.boost_geometry_index_rtree.member29"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.boost_geometry_index_rtree.member29" title="get_allocator()">get_allocator()</a>
@@ -3349,9 +3259,6 @@
If allocator copy constructor throws.
</p>
</div>
-<p>
- <br>
- </p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -3685,9 +3592,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function1" title="insert(rtree<...> &, Iterator, Iterator)">insert(rtree<...>
@@ -3799,9 +3703,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function2" title="insert(rtree<...> &, Range const &)">insert(rtree<...>
@@ -3895,9 +3796,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function3" title="remove(rtree<...> &, Value const &)">remove(rtree<...>
@@ -4005,9 +3903,6 @@
1 if value was removed, 0 otherwise.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function4" title="remove(rtree<...> &, Iterator, Iterator)">remove(rtree<...>
@@ -4137,9 +4032,6 @@
The number of removed values.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function5" title="remove(rtree<...> &, Range const &)">remove(rtree<...>
@@ -4250,9 +4142,6 @@
The number of removed values.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function6" title="spatial_query(rtree<...> const &, Predicates const &, OutIter)">spatial_query(rtree<...>
@@ -4372,9 +4261,6 @@
The number of found values.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function7"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function7" title="nearest_query(rtree<...> const &, DistancesPredicates const &, Value &)">nearest_query(rtree<...>
@@ -4494,9 +4380,6 @@
The number of found values.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function8"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function8" title="nearest_query(rtree<...> const &, DistancesPredicates const &, Predicates const &, Value &)">nearest_query(rtree<...>
@@ -4636,9 +4519,6 @@
The number of found values.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function9"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function9" title="nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, OutIter)">nearest_query(rtree<...>
@@ -4777,9 +4657,6 @@
The number of found values.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function10"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function10" title="nearest_query(rtree<...> const &, DistancesPredicates const &, size_t, Predicates const &, OutIter)">nearest_query(rtree<...>
@@ -4938,9 +4815,6 @@
The number of found values.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function11"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function11" title="clear(rtree<...> &)">clear(rtree<...>
@@ -5013,9 +4887,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function12"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function12" title="size(rtree<...> const &)">size(rtree<...>
@@ -5095,9 +4966,6 @@
The number of values stored in the index.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function13"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function13" title="empty(rtree<...> const &)">empty(rtree<...>
@@ -5177,9 +5045,6 @@
true if there are no values in the index.
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__rtree__functions.function14"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__rtree__functions.function14" title="box(rtree<...> const &)">box(rtree<...>
@@ -5260,9 +5125,6 @@
The box containing all stored values or an invalid box.
</p>
</div>
-<p>
- <br>
- </p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -5396,9 +5258,6 @@
<p>
</p>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function1" title="value(ValuePredicate const &)">value(ValuePredicate
@@ -5471,9 +5330,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function2" title="covered_by(Geometry const &)">covered_by(Geometry
@@ -5548,9 +5404,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function3" title="disjoint(Geometry const &)">disjoint(Geometry
@@ -5625,9 +5478,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function4" title="intersects(Geometry const &)">intersects(Geometry
@@ -5702,9 +5552,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function5" title="overlaps(Geometry const &)">overlaps(Geometry
@@ -5779,9 +5626,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__predicates.function6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__predicates.function6" title="within(Geometry const &)">within(Geometry
@@ -5856,9 +5700,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -6059,9 +5900,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function1" title="to_centroid(T const &)">to_centroid(T
@@ -6138,9 +5976,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function2" title="to_furthest(T const &)">to_furthest(T
@@ -6219,9 +6054,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function3"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function3" title="unbounded(PointRelation const &)">unbounded(PointRelation
@@ -6298,9 +6130,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function4"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function4" title="min_bounded(PointRelation const &, MinRelation const &)">min_bounded(PointRelation
@@ -6399,9 +6228,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function5"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function5" title="max_bounded(PointRelation const &, MaxRelation const &)">max_bounded(PointRelation
@@ -6500,9 +6326,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__distance__predicates.function6"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__distance__predicates.function6" title="bounded(PointRelation const &, MinRelation const &, MaxRelation const &)">bounded(PointRelation
@@ -6624,9 +6447,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -6796,9 +6616,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__adaptors.function1"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function1" title="nearest_queried(DistancesPredicates const &, size_t)">nearest_queried(DistancesPredicates
@@ -6883,9 +6700,6 @@
</tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="geometry_index.r_tree.reference.group__adaptors.function2"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.group__adaptors.function2" title="spatial_queried(Predicates const &)">spatial_queried(Predicates
@@ -6950,9 +6764,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
@@ -6964,7 +6775,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_def" title="boost::geometry::index::translator::def">boost::geometry::index::translator::def</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id923026"></a><a class="indexterm" name="id923031"></a><a class="indexterm" name="id923036"></a><a class="indexterm" name="id923041"></a><a class="indexterm" name="id923045"></a>
+ <a class="indexterm" name="id935919"></a><a class="indexterm" name="id935924"></a><a class="indexterm" name="id935929"></a><a class="indexterm" name="id935934"></a><a class="indexterm" name="id935938"></a>
The default translator.
</p>
<h6>
@@ -7038,7 +6849,7 @@
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index" title="boost::geometry::index::translator::index">boost::geometry::index::translator::index</a>
</h5></div></div></div>
<p>
- <a class="indexterm" name="id923300"></a><a class="indexterm" name="id923305"></a><a class="indexterm" name="id923309"></a><a class="indexterm" name="id923314"></a><a class="indexterm" name="id923319"></a>
+ <a class="indexterm" name="id936193"></a><a class="indexterm" name="id936198"></a><a class="indexterm" name="id936202"></a><a class="indexterm" name="id936207"></a><a class="indexterm" name="id936212"></a>
The index translator.
</p>
<h6>
@@ -7144,9 +6955,6 @@
</td>
</tr></tbody>
</table></div>
-<p>
- <br>
- </p>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0"></a><a class="link" href="reference.html#geometry_index.r_tree.reference.translators.boost_geometry_index_translator_index.member0" title="index(Container const &)">index(Container
@@ -7206,9 +7014,6 @@
</tr></tbody>
</table></div>
</div>
-<p>
- <br>
- </p>
</div>
</div>
<div class="section">
@@ -7326,9 +7131,6 @@
The insert iterator inserting values to the container.
</p>
</div>
-<p>
- <br>
- </p>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
Modified: sandbox-branches/geometry/index/doc/html/index.html
==============================================================================
--- sandbox-branches/geometry/index/doc/html/index.html (original)
+++ sandbox-branches/geometry/index/doc/html/index.html 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -56,7 +56,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: January 09, 2013 at 23:45:57 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 10, 2013 at 20:11:29 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp
==============================================================================
--- sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp (original)
+++ sandbox-branches/geometry/index/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp 2013-01-10 15:12:40 EST (Thu, 10 Jan 2013)
@@ -673,6 +673,11 @@
return res;
}
+std::string replace_brackets(std::string const& str)
+{
+ return boost::replace_all_copy(boost::replace_all_copy(str, "[", "\\["), "]", "\\]");
+}
+
void quickbook_synopsis_short(function const& f, std::ostream& out)
{
switch(f.type)
@@ -694,24 +699,21 @@
break;
}
- // Output the parameters
- // Because we want to be able to skip, we cannot use the argstring
+ bool first = true;
+ BOOST_FOREACH(parameter const& p, f.parameters)
{
- bool first = true;
- BOOST_FOREACH(parameter const& p, f.parameters)
+ if ( !p.skip && p.default_value.empty() )
{
- if ( !p.skip && p.default_value.empty() )
- {
- out << (first ? "(" : ", ") << remove_template_parameters(p.fulltype);
- first = false;
- }
+ out << (first ? "(" : ", ") << remove_template_parameters(p.fulltype);
+ first = false;
}
-
- if (! first)
- out << ")";
- else if (f.type != function_define)
- out << "()";
}
+
+
+ if (! first)
+ out << ")";
+ else if (f.type != function_define)
+ out << "()";
}
void quickbook_output_function(std::vector<function> const& functions,
@@ -739,7 +741,7 @@
out << "`";
if ( !config.index_id_path.empty() )
out << "]";
- out << "][" << f.brief_description << "]]" << std::endl;
+ out << "][" << replace_brackets(f.brief_description) << "]]" << std::endl;
}
}
out << "]" << std::endl
@@ -758,24 +760,29 @@
function const& f = functions[i];
if ( display_all || f.type == type )
{
+ // Section
std::stringstream ss;
quickbook_synopsis_short(f, ss);
+ out << "[section:" << qbk_id_prefix << i << " " << replace_brackets(ss.str()) << "]" << std::endl;
- out << "[section:" << qbk_id_prefix << i << " " << ss.str() << "]" << std::endl;
-
- out << f.brief_description;
+ // Brief description
+ out << f.brief_description << std::endl;
+ out << std::endl;
+ // Detail description
if ( !f.detailed_description.empty() )
{
out << "[heading Description]" << std::endl;
out << f.detailed_description;
}
+ // Synopsis
quickbook_markup(f.qbk_markup, markup_before, markup_synopsis, out);
out << "[heading Synopsis]" << std::endl;
quickbook_synopsis(f, out, true, true);
quickbook_markup(f.qbk_markup, markup_after, markup_synopsis, out);
+ // Parameters
if ( !f.parameters.empty() )
{
out << "[heading Parameters]" << std::endl;
@@ -785,22 +792,25 @@
{
if (!p.skip)
{
- out << "[[ `" << p.fulltype << "` ][ `" << p.name << "` ][" << p.brief_description << "]]"<< std::endl;
+ out << "[[ `" << p.fulltype << "` ][ `" << p.name << "` ][" << replace_brackets(p.brief_description) << "]]"<< std::endl;
}
}
out << "]" << std::endl;
}
+ // Return
if ( !f.return_description.empty() )
{
out << "[heading Returns]" << std::endl;
out << f.return_description << std::endl;
}
+ // QBK markup
quickbook_markup(f.qbk_markup, markup_any, markup_default, out);
+ // Section end
out << "[endsect]" << std::endl
- << "[br]" << std::endl
+ //<< "[br]" << std::endl
<< std::endl;
}
}
@@ -932,7 +942,7 @@
out << p.fulltype.substr(6);
else
out << p.fulltype;
- out << "`][" << p.brief_description << "]]" << std::endl;
+ out << "`][" << replace_brackets(p.brief_description) << "]]" << std::endl;
}
out << "]" << std::endl
<< std::endl;
@@ -956,7 +966,7 @@
continue;
out << "[[`" << e.name;
- out << "`][" << e.brief_description << "]]" << std::endl;
+ out << "`][" << replace_brackets(e.brief_description) << "]]" << std::endl;
}
out << "]" << std::endl
<< std::endl;
@@ -988,8 +998,8 @@
// Details start
- if ( display_ctors || display_members )
- out << "[br]" << std::endl;
+ //if ( display_ctors || display_members )
+ // out << "[br]" << std::endl;
if (display_ctors && counts[function_constructor_destructor] > 0)
quickbook_output_detail_function(cos.functions, function_constructor_destructor, config, "member", out);
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