From a75b7cdc0aae8dd47fd4e31660dede866d093b84 Mon Sep 17 00:00:00 2001 From: Adam Wulkiewicz Date: Tue, 8 Jan 2013 05:03:50 +0000 Subject: [PATCH] Exceptions info moved to \qbk section in methods description. [SVN r82399] --- doc/html/geometry_index/r_tree/index.html | 593 ++++++++++-------- doc/html/index.html | 2 +- .../doxygen_xml2qbk/quickbook_output.hpp | 18 +- 3 files changed, 360 insertions(+), 253 deletions(-) diff --git a/doc/html/geometry_index/r_tree/index.html b/doc/html/geometry_index/r_tree/index.html index 445c32f79..99ccfb8be 100644 --- a/doc/html/geometry_index/r_tree/index.html +++ b/doc/html/geometry_index/r_tree/index.html @@ -31,7 +31,7 @@ boost::geometry::index::rtree

- + The R-tree spatial index.

@@ -364,8 +364,7 @@ The R-tree spatial index.

- The copy constructor. It uses Parameters and translator from - the source tree. + The copy constructor.

@@ -694,12 +693,22 @@ The R-tree spatial index. +

+
+

+ Description +
+

+ The constructor. +

+
+ Synopsis

@@ -710,13 +719,6 @@ The R-tree spatial index.

- - Description -
-

- The constructor. -

-
Parameters
@@ -798,6 +800,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ The constructor. +

+
+ Synopsis

@@ -818,13 +830,6 @@ The R-tree spatial index.

- - Description -
-

- The constructor. -

-
Parameters
@@ -940,6 +945,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ The constructor. +

+
+ Synopsis

@@ -959,13 +974,6 @@ The R-tree spatial index.

- - Description -
-

- The constructor. -

-
Parameters
@@ -1065,12 +1073,29 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ { +

+
+ + Exception-safety +
+

+ nothrow } +

+
+ Synopsis

@@ -1078,14 +1103,10 @@ The R-tree spatial index. 

~rtree()

-
- - Description -
-

- The destructor. -

+

+
+

+ Description +
+

+ The copy constructor. It uses parameters, translator and allocator from + the source tree. +

+
+ Synopsis

@@ -1101,14 +1130,6 @@ The R-tree spatial index.

- - Description -
-

- The copy constructor. It uses parameters, translator and allocator from - the source tree. -

-
Parameters
@@ -1155,6 +1176,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ The copy constructor. It uses Parameters and translator from the source + tree. +

+
+ Synopsis

@@ -1170,14 +1202,6 @@ The R-tree spatial index.

- - Description -
-

- The copy constructor. It uses Parameters and translator from the source - tree. -

-
Parameters
@@ -1243,6 +1267,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ The moving constructor. It uses parameters, translator and allocator + from the source tree. +

+
+ Synopsis

@@ -1258,14 +1293,6 @@ The R-tree spatial index.

- - Description -
-

- The moving constructor. It uses parameters, translator and allocator - from the source tree. -

-
Parameters
@@ -1311,6 +1338,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ The assignment operator. It uses parameters and translator from the source + tree. +

+
+ Synopsis

@@ -1326,14 +1364,6 @@ The R-tree spatial index.

- - Description -
-

- The assignment operator. It uses parameters and translator from the source - tree. -

-
Parameters
@@ -1380,6 +1410,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ The moving assignment. It uses parameters and translator from the source + tree. +

+
+ Synopsis

@@ -1395,14 +1436,6 @@ The R-tree spatial index.

- - Description -
-

- The moving assignment. It uses parameters and translator from the source - tree. -

-
Parameters
@@ -1448,6 +1481,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ Swaps contents of two rtrees. Parameters, translator and allocators are + swapped as well. +

+
+ Synopsis

@@ -1463,14 +1507,6 @@ The R-tree spatial index.

- - Description -
-

- Swaps contents of two rtrees. Parameters, translator and allocators are - swapped as well. -

-
Parameters
@@ -1516,6 +1552,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ Insert a value to the index. +

+
+ Synopsis

@@ -1531,13 +1577,6 @@ The R-tree spatial index.

- - Description -
-

- Insert a value to the index. -

-
Parameters
@@ -1583,6 +1622,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ Insert a range of values to the index. +

+
+ Synopsis

@@ -1599,13 +1648,6 @@ The R-tree spatial index.

- - Description -
-

- Insert a range of values to the index. -

-
Parameters
@@ -1670,6 +1712,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ Insert a range of values to the index. +

+
+ Synopsis

@@ -1686,13 +1738,6 @@ The R-tree spatial index.

- - Description -
-

- Insert a range of values to the index. -

-
Parameters
@@ -1739,6 +1784,9 @@ The R-tree spatial index.
+

+
+

+ Description +
+

+ In contrast to the STL set/map erase() method this method removes only + one value from the container. +

+
+ Synopsis

@@ -1754,14 +1810,6 @@ The R-tree spatial index.

- - Description -
-

- In contrast to the STL set/map erase() method this method removes only - one value from the container. -

-
Parameters
@@ -1814,6 +1862,9 @@ The R-tree spatial index. 1 if the value was removed, 0 otherwise.

+

+
+

- Synopsis -
-

-

-
template<typename Iterator>
-size_type remove(Iterator first, Iterator last)
-

-

-
- Description

@@ -1840,6 +1881,16 @@ The R-tree spatial index. value for each one passed in the range, not all equal values.

+ + Synopsis +
+

+

+
template<typename Iterator>
+size_type remove(Iterator first, Iterator last)
+

+

+
Parameters
@@ -1911,6 +1962,9 @@ The R-tree spatial index. The number of removed values.

+

+
+

+ 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. +

+
+ Synopsis

@@ -1927,15 +1990,6 @@ The R-tree spatial index.

- - 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. -

-
Parameters
@@ -1989,6 +2043,9 @@ The R-tree spatial index. The number of removed values.

+

+
+

- Synopsis -
-

-

-
template<typename Predicates, typename OutIter>
-size_type spatial_query(Predicates const & pred, OutIter out_it)
-

-

-
- Description

@@ -2017,6 +2064,16 @@ The R-tree spatial index. Those predicates may be passed together in std::pair or boost::tuple.

+ + Synopsis +
+

+

+
template<typename Predicates, typename OutIter>
+size_type spatial_query(Predicates const & pred, OutIter out_it)
+

+

+
Parameters
@@ -2089,6 +2146,9 @@ The R-tree spatial index. The number of values found.

+

+
+

- Synopsis -
-

-

-
template<typename DistancesPredicates>
-size_type nearest_query(DistancesPredicates const & dpred, value_type & v)
-

-

-
- Description

@@ -2122,6 +2172,16 @@ The R-tree spatial index. or bgi::to_furthest(dist_bound).

+ + Synopsis +
+

+

+
template<typename DistancesPredicates>
+size_type nearest_query(DistancesPredicates const & dpred, value_type & v)
+

+

+
Parameters
@@ -2194,6 +2254,9 @@ The R-tree spatial index. The number of values found.

+

+
+

- Synopsis -
-

-

-
template<typename DistancesPredicates, typename Predicates>
-size_type nearest_query(DistancesPredicates const & dpred,
-                        Predicates const & pred,
-                        value_type & v)
-

-

-
- Description

@@ -2237,6 +2288,18 @@ The R-tree spatial index. Those predicates may be passed together in std::pair or boost::tuple.

+ + Synopsis +
+

+

+
template<typename DistancesPredicates, typename Predicates>
+size_type nearest_query(DistancesPredicates const & dpred,
+                        Predicates const & pred,
+                        value_type & v)
+

+

+
Parameters
@@ -2326,6 +2389,9 @@ The R-tree spatial index. The number of values found.

+

+
+

- Synopsis -
-

-

-
template<typename DistancesPredicates, typename OutIter>
-size_type nearest_query(DistancesPredicates const & dpred,
-                        size_t k,
-                        OutIter out_it)
-

-

-
- Description

@@ -2361,6 +2415,18 @@ The R-tree spatial index. or bgi::to_furthest(dist_bound).

+ + Synopsis +
+

+

+
template<typename DistancesPredicates, typename OutIter>
+size_type nearest_query(DistancesPredicates const & dpred,
+                        size_t k,
+                        OutIter out_it)
+

+

+
Parameters
@@ -2450,6 +2516,9 @@ The R-tree spatial index. The number of values found.

+

+
+

- Synopsis -
-

-

-
template<typename DistancesPredicates,
-         typename Predicates,
-         typename OutIter>
-size_type nearest_query(DistancesPredicates const & dpred,
-                        size_t k,
-                        Predicates const & pred,
-                        OutIter out_it)
-

-

-
- Description

@@ -2496,6 +2550,21 @@ The R-tree spatial index. Those predicates may be passed together in std::pair or boost::tuple.

+ + Synopsis +
+

+

+
template<typename DistancesPredicates,
+         typename Predicates,
+         typename OutIter>
+size_type nearest_query(DistancesPredicates const & dpred,
+                        size_t k,
+                        Predicates const & pred,
+                        OutIter out_it)
+

+

+
Parameters
@@ -2602,12 +2671,22 @@ The R-tree spatial index. The number of values found.

+

+
+

+ Description +
+

+ Returns the number of stored values. +

+
+ Synopsis

@@ -2616,13 +2695,6 @@ The R-tree spatial index.

- - Description -
-

- Returns the number of stored values. -

-
Returns
@@ -2630,12 +2702,22 @@ The R-tree spatial index. The number of stored values.

+

+
+

+ Description +
+

+ Query if the container is empty. +

+
+ Synopsis

@@ -2644,13 +2726,6 @@ The R-tree spatial index.

- - Description -
-

- Query if the container is empty. -

-
Returns
@@ -2658,12 +2733,29 @@ The R-tree spatial index. true if the container is empty.

+

+
+

+ Description +
+

+ { +

+
+ + Exception-safety +
+

+ nothrow } +

+
+ Synopsis

@@ -2671,20 +2763,24 @@ The R-tree spatial index. 

void clear()

-
- - Description -
-

- Removes all values stored in the container. -

+

+
+

+ Description +
+

+ Returns the box containing all values stored in the container. If the + container is empty the result of geometry::assign_inverse() is returned. +

+
+ Synopsis

@@ -2693,14 +2789,6 @@ The R-tree spatial index.

- - Description -
-

- Returns the box containing all values stored in the container. If the - container is empty the result of geometry::assign_inverse() is returned. -

-
Returns
@@ -2709,6 +2797,9 @@ The R-tree spatial index. if there are no values in the container.

+

+
+

+ 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. +

+
+ Synopsis

@@ -2725,15 +2825,6 @@ The R-tree spatial index.

- - 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. -

-
Parameters
@@ -2787,12 +2878,22 @@ The R-tree spatial index. The number of values found.

+

+
+

+ Description +
+

+ Returns parameters. +

+
+ Synopsis

@@ -2801,13 +2902,6 @@ The R-tree spatial index.

- - Description -
-

- Returns parameters. -

-
Returns
@@ -2815,12 +2909,22 @@ The R-tree spatial index. The parameters object.

+

+
+

+ Description +
+

+ Returns the translator object. +

+
+ Synopsis

@@ -2829,13 +2933,6 @@ The R-tree spatial index.

- - Description -
-

- Returns the translator object. -

-
Returns
@@ -2843,12 +2940,22 @@ The R-tree spatial index. The translator object.

+

+
+

+ Description +
+

+ Returns allocator used by the rtree. +

+
+ Synopsis

@@ -2857,13 +2964,6 @@ The R-tree spatial index.

- - Description -
-

- Returns allocator used by the rtree. -

-
Returns
@@ -2871,6 +2971,9 @@ The R-tree spatial index. The allocator.

+

+
+

diff --git a/doc/html/index.html b/doc/html/index.html index ea7fc22ca..b08ef5114 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -57,7 +57,7 @@
- +

Last revised: January 08, 2013 at 03:33:47 GMT

Last revised: January 08, 2013 at 05:02:12 GMT
diff --git a/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp b/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp index 00c715d65..1055067ac 100644 --- a/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp +++ b/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp @@ -728,9 +728,6 @@ void quickbook_output_detail_member(class_or_struct const& cos, out << "[section:member" << i << " " << ss.str() << "]" << std::endl; - out << "[heading Synopsis]" << std::endl; - quickbook_synopsis(f, out, true, true); - if ( !f.detailed_description.empty() || !f.brief_description.empty() ) { out << "[heading Description]" << std::endl; @@ -738,7 +735,10 @@ void quickbook_output_detail_member(class_or_struct const& cos, out << f.detailed_description; else out << f.brief_description; - } + } + + out << "[heading Synopsis]" << std::endl; + quickbook_synopsis(f, out, true, true); if ( !f.parameters.empty() ) { @@ -759,9 +759,11 @@ void quickbook_output_detail_member(class_or_struct const& cos, { out << "[heading Returns]" << std::endl; out << f.return_description << std::endl; - } - - out << "[endsect]" << std::endl + } + + quickbook_markup(f.qbk_markup, markup_any, markup_default, out); + + out << "[endsect][br]" << std::endl << std::endl; } } @@ -891,6 +893,8 @@ void quickbook_output(class_or_struct const& cos, configuration const& config, s // Details start + out << "[br]"; + if (counts[function_constructor_destructor] > 0) quickbook_output_detail_member(cos, cos.functions, function_constructor_destructor, config, out); if (counts[function_member] > 0)