diff --git a/doc/html/geometry_index/r_tree/index.html b/doc/html/geometry_index/r_tree/index.html index c8452c806..445c32f79 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.

@@ -294,7 +294,7 @@ The R-tree spatial index.

- rtree() + rtree()

@@ -306,8 +306,8 @@ The R-tree spatial index.

- rtree(Iterator, - Iterator) + rtree(Iterator, + Iterator)

@@ -319,8 +319,8 @@ The R-tree spatial index.

- rtree(Range const - &) + rtree(Range const + &)

@@ -332,7 +332,7 @@ The R-tree spatial index.

- ~rtree() + ~rtree()

@@ -344,8 +344,8 @@ The R-tree spatial index.

- rtree(rtree const - &) + rtree(rtree const + &)

@@ -357,9 +357,9 @@ The R-tree spatial index.

- rtree(rtree const + rtree(rtree const &, allocator_type - const &) + const &)

@@ -372,7 +372,7 @@ The R-tree spatial index.

- rtree(rtree &&) + rtree(rtree &&)

@@ -408,8 +408,8 @@ The R-tree spatial index.

- operator=(const rtree - &) + operator=(const rtree + &)

@@ -421,7 +421,7 @@ The R-tree spatial index.

- operator=(rtree &&) + operator=(rtree &&)

@@ -433,7 +433,7 @@ The R-tree spatial index.

- swap(rtree &) + swap(rtree &)

@@ -445,8 +445,8 @@ The R-tree spatial index.

- insert(value_type const - &) + insert(value_type const + &)

@@ -458,8 +458,8 @@ The R-tree spatial index.

- insert(Iterator, - Iterator) + insert(Iterator, + Iterator)

@@ -471,8 +471,8 @@ The R-tree spatial index.

- insert(Range const - &) + insert(Range const + &)

@@ -484,8 +484,8 @@ The R-tree spatial index.

- remove(value_type const - &) + remove(value_type const + &)

@@ -497,8 +497,8 @@ The R-tree spatial index.

- remove(Iterator, - Iterator) + remove(Iterator, + Iterator)

@@ -510,8 +510,8 @@ The R-tree spatial index.

- remove(Range const - &) + remove(Range const + &)

@@ -523,9 +523,8 @@ The R-tree spatial index.

- spatial_query(Predicates - const &, - OutIter) + spatial_query(Predicates const + &, OutIter)

@@ -538,9 +537,9 @@ The R-tree spatial index.

- nearest_query(DistancesPredicates - const &, - value_type &) + nearest_query(DistancesPredicates const + &, value_type + &)

@@ -553,11 +552,10 @@ The R-tree spatial index.

- nearest_query(DistancesPredicates + nearest_query(DistancesPredicates const + &, Predicates const &, - Predicates const - &, value_type - &) + value_type &)

@@ -570,10 +568,8 @@ The R-tree spatial index.

- nearest_query(DistancesPredicates - const &, - size_t, - OutIter) + nearest_query(DistancesPredicates const + &, size_t, OutIter)

@@ -586,11 +582,10 @@ The R-tree spatial index.

- nearest_query(DistancesPredicates + nearest_query(DistancesPredicates const + &, size_t, Predicates const &, - size_t, - Predicates const - &, OutIter) + OutIter)

@@ -603,7 +598,7 @@ The R-tree spatial index.

- size() + size()

@@ -615,7 +610,7 @@ The R-tree spatial index.

- empty() + empty()

@@ -627,7 +622,7 @@ The R-tree spatial index.

- clear() + clear()

@@ -639,7 +634,7 @@ The R-tree spatial index.

- box() + box()

@@ -651,8 +646,8 @@ The R-tree spatial index.

- count(ValueOrIndexable const - &) + count(ValueOrIndexable const + &)

@@ -664,7 +659,7 @@ The R-tree spatial index.

- parameters() + parameters()

@@ -676,7 +671,7 @@ The R-tree spatial index.

- translator() + translator()

@@ -688,7 +683,7 @@ The R-tree spatial index.

- get_allocator() + get_allocator()

@@ -701,11 +696,11 @@ The R-tree spatial index.
-rtree() +rtree()
- - Synopsis + + Synopsis

@@ -715,15 +710,15 @@ The R-tree spatial index.

- - Description + + Description

The constructor.

- - Parameters + + Parameters
@@ -805,12 +800,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -823,15 +818,15 @@ The R-tree spatial index.

- - Description + + Description

The constructor.

- - Parameters + + Parameters
@@ -947,12 +942,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -964,15 +959,15 @@ The R-tree spatial index.

- - Description + + Description

The constructor.

- - Parameters + + Parameters
@@ -1072,11 +1067,11 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1084,8 +1079,8 @@ The R-tree spatial index.

- - Description + + Description

The destructor. @@ -1093,12 +1088,12 @@ The R-tree spatial index.

- - Synopsis + + Synopsis

@@ -1106,16 +1101,16 @@ The R-tree spatial index.

- - Description + + Description

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

- - Parameters + + Parameters
@@ -1162,12 +1157,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1175,16 +1170,16 @@ The R-tree spatial index.

- - Description + + Description

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

- - Parameters + + Parameters
@@ -1250,12 +1245,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1263,16 +1258,16 @@ The R-tree spatial index.

- - Description + + Description

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

- - Parameters + + Parameters
@@ -1318,12 +1313,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1331,16 +1326,16 @@ The R-tree spatial index.

- - Description + + Description

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

- - Parameters + + Parameters
@@ -1387,12 +1382,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1400,16 +1395,16 @@ The R-tree spatial index.

- - Description + + Description

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

- - Parameters + + Parameters
@@ -1455,12 +1450,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1468,16 +1463,16 @@ The R-tree spatial index.

- - Description + + Description

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

- - Parameters + + Parameters
@@ -1523,12 +1518,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1536,15 +1531,15 @@ The R-tree spatial index.

- - Description + + Description

Insert a value to the index.

- - Parameters + + Parameters
@@ -1590,12 +1585,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1604,15 +1599,15 @@ The R-tree spatial index.

- - Description + + Description

Insert a range of values to the index.

- - Parameters + + Parameters
@@ -1677,12 +1672,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1691,15 +1686,15 @@ The R-tree spatial index.

- - Description + + Description

Insert a range of values to the index.

- - Parameters + + Parameters
@@ -1746,12 +1741,12 @@ The R-tree spatial index.
- - Synopsis + + Synopsis

@@ -1759,16 +1754,16 @@ The R-tree spatial index.

- - Description + + Description

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

- - Parameters + + Parameters
@@ -1812,8 +1807,8 @@ The R-tree spatial index.
- - Returns + + Returns

1 if the value was removed, 0 otherwise. @@ -1821,12 +1816,12 @@ The R-tree spatial index.

-remove(Iterator, +remove(Iterator, Iterator)
- - Synopsis + + Synopsis

@@ -1835,8 +1830,8 @@ The R-tree spatial index.

- - Description + + Description

In contrast to the STL set/map erase() method it doesn't take iterators @@ -1845,8 +1840,8 @@ The R-tree spatial index. value for each one passed in the range, not all equal values.

- - Parameters + + Parameters
@@ -1909,8 +1904,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of removed values. @@ -1918,12 +1913,12 @@ The R-tree spatial index.

-remove(Range +remove(Range const &)
- - Synopsis + + Synopsis

@@ -1932,8 +1927,8 @@ The R-tree spatial index.

- - Description + + Description

In contrast to the STL set/map erase() method it removes values equal @@ -1941,8 +1936,8 @@ The R-tree spatial index. value for each one passed in the range, not all equal values.

- - Parameters + + Parameters
@@ -1987,8 +1982,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of removed values. @@ -1996,12 +1991,12 @@ The R-tree spatial index.

-spatial_query(Predicates +spatial_query(Predicates const &, OutIter)
- - Synopsis + + Synopsis

@@ -2010,8 +2005,8 @@ The R-tree spatial index.

- - Description + + Description

Spatial predicates may be a Geometry (in this case default predicate @@ -2022,8 +2017,8 @@ The R-tree spatial index. Those predicates may be passed together in std::pair or boost::tuple.

- - Parameters + + Parameters
@@ -2087,8 +2082,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of values found. @@ -2096,12 +2091,12 @@ The R-tree spatial index.

-nearest_query(DistancesPredicates +nearest_query(DistancesPredicates const &, value_type &)
- - Synopsis + + Synopsis

@@ -2110,8 +2105,8 @@ The R-tree spatial index.

- - Description + + Description

The distances predicates may be a Point. This is default case where Value @@ -2127,8 +2122,8 @@ The R-tree spatial index. or bgi::to_furthest(dist_bound).

- - Parameters + + Parameters
@@ -2192,8 +2187,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of values found. @@ -2201,12 +2196,12 @@ The R-tree spatial index.

-nearest_query(DistancesPredicates +nearest_query(DistancesPredicates const &, Predicates const &, value_type &)
- - Synopsis + + Synopsis

@@ -2217,8 +2212,8 @@ The R-tree spatial index.

- - Description + + Description

The distances predicates may be a Point. This is default case where Value @@ -2242,8 +2237,8 @@ The R-tree spatial index. Those predicates may be passed together in std::pair or boost::tuple.

- - Parameters + + Parameters
@@ -2324,8 +2319,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of values found. @@ -2333,12 +2328,12 @@ The R-tree spatial index.

-nearest_query(DistancesPredicates +nearest_query(DistancesPredicates const &, size_t, OutIter)
- - Synopsis + + Synopsis

@@ -2349,8 +2344,8 @@ The R-tree spatial index.

- - Description + + Description

The distances predicates. May be a Point. This is default case where @@ -2366,8 +2361,8 @@ The R-tree spatial index. or bgi::to_furthest(dist_bound).

- - Parameters + + Parameters
@@ -2448,8 +2443,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of values found. @@ -2457,12 +2452,12 @@ The R-tree spatial index.

-nearest_query(DistancesPredicates +nearest_query(DistancesPredicates const &, size_t, Predicates const &, OutIter)
- - Synopsis + + Synopsis

@@ -2476,8 +2471,8 @@ The R-tree spatial index.

- - Description + + Description

The distances predicates may be a Point. This is default case where Value @@ -2501,8 +2496,8 @@ The R-tree spatial index. Those predicates may be passed together in std::pair or boost::tuple.

- - Parameters + + Parameters
@@ -2600,8 +2595,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of values found. @@ -2609,11 +2604,11 @@ The R-tree spatial index.

-size() +size()
- - Synopsis + + Synopsis

@@ -2621,15 +2616,15 @@ The R-tree spatial index.

- - Description + + Description

Returns the number of stored values.

- - Returns + + Returns

The number of stored values. @@ -2637,11 +2632,11 @@ The R-tree spatial index.

-empty() +empty()
- - Synopsis + + Synopsis

@@ -2649,15 +2644,15 @@ The R-tree spatial index.

- - Description + + Description

Query if the container is empty.

- - Returns + + Returns

true if the container is empty. @@ -2665,11 +2660,11 @@ The R-tree spatial index.

-clear() +clear()
- - Synopsis + + Synopsis

@@ -2677,8 +2672,8 @@ The R-tree spatial index.

- - Description + + Description

Removes all values stored in the container. @@ -2686,11 +2681,11 @@ The R-tree spatial index.

-box() +box()
- - Synopsis + + Synopsis

@@ -2698,16 +2693,16 @@ The R-tree spatial index.

- - Description + + 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 + + Returns

The box containing all values stored in the container or an invalid box @@ -2716,12 +2711,12 @@ The R-tree spatial index.

-count(ValueOrIndexable +count(ValueOrIndexable const &)
- - Synopsis + + Synopsis

@@ -2730,8 +2725,8 @@ The R-tree spatial index.

- - Description + + Description

For indexable_type it returns the number of values which indexables equals @@ -2739,8 +2734,8 @@ The R-tree spatial index. the parameter.

- - Parameters + + Parameters
@@ -2785,8 +2780,8 @@ The R-tree spatial index.
- - Returns + + Returns

The number of values found. @@ -2794,11 +2789,11 @@ The R-tree spatial index.

-parameters() +parameters()
- - Synopsis + + Synopsis

@@ -2806,15 +2801,15 @@ The R-tree spatial index.

- - Description + + Description

Returns parameters.

- - Returns + + Returns

The parameters object. @@ -2822,11 +2817,11 @@ The R-tree spatial index.

-translator() +translator()
- - Synopsis + + Synopsis

@@ -2834,15 +2829,15 @@ The R-tree spatial index.

- - Description + + Description

Returns the translator object.

- - Returns + + Returns

The translator object. @@ -2850,11 +2845,11 @@ The R-tree spatial index.

-get_allocator() +get_allocator()
- - Synopsis + + Synopsis

@@ -2862,15 +2857,15 @@ The R-tree spatial index.

- - Description + + Description

Returns allocator used by the rtree.

- - Returns + + Returns

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

- +

Last revised: January 08, 2013 at 01:06:35 GMT

Last revised: January 08, 2013 at 03:33:47 GMT
diff --git a/doc/make_qbk.py b/doc/make_qbk.py index 0434b678a..5f2b0fbee 100755 --- a/doc/make_qbk.py +++ b/doc/make_qbk.py @@ -13,9 +13,10 @@ import os, sys cmd = "doxygen_xml2qbk" cmd = cmd + " --xml xml/%s.xml" cmd = cmd + " --start_include ." +cmd = cmd + " --document_id_path %s" cmd = cmd + " > generated/%s.qbk" os.system("doxygen Doxyfile") -os.system(cmd % ("classboost_1_1geometry_1_1index_1_1rtree", "rtree")) +os.system(cmd % ("classboost_1_1geometry_1_1index_1_1rtree", "geometry_index.r_tree.index.boost_geometry_index_rtree", "rtree")) os.system("b2") diff --git a/doc/src/tools/doxygen_xml2qbk/configuration.hpp b/doc/src/tools/doxygen_xml2qbk/configuration.hpp index 96cf8104c..fded4e794 100644 --- a/doc/src/tools/doxygen_xml2qbk/configuration.hpp +++ b/doc/src/tools/doxygen_xml2qbk/configuration.hpp @@ -27,6 +27,8 @@ struct configuration std::vector convenience_headers; std::string skip_namespace; + + std::string document_id_path; }; diff --git a/doc/src/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp b/doc/src/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp index c36f85b60..ecbad95ce 100644 --- a/doc/src/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp +++ b/doc/src/tools/doxygen_xml2qbk/doxygen_xml2qbk.cpp @@ -75,6 +75,8 @@ int main(int argc, char** argv) "Namespace to skip (e.g. boost::mylib::") ("copyright", po::value(©right_filename), "Name of QBK file including (commented) copyright and license") + ("document_id_path", po::value(&config.document_id_path), + "The QBK document ID path") ; po::variables_map varmap; @@ -103,6 +105,9 @@ int main(int argc, char** argv) { boost::split(config.convenience_headers, convenience_headers, boost::is_any_of(",")); } + + if ( !config.document_id_path.empty() && config.document_id_path[config.document_id_path.size() - 1] != '.' ) + config.document_id_path += '.'; } // Read files into strings diff --git a/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp b/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp index fc9feef88..00c715d65 100644 --- a/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp +++ b/doc/src/tools/doxygen_xml2qbk/quickbook_output.hpp @@ -698,9 +698,15 @@ void quickbook_output_member(class_or_struct const& cos, if (f.type == type) { - out << "[[`"; + out << "[["; + if ( !config.document_id_path.empty() ) + out << "[link " << config.document_id_path << "member" << i << " "; + out << "`"; quickbook_synopsis_short(f, out); - out << "`][" << f.brief_description << "]]" << std::endl; + out << "`"; + if ( !config.document_id_path.empty() ) + out << "]"; + out << "][" << f.brief_description << "]]" << std::endl; } } out << "]" << std::endl @@ -720,7 +726,7 @@ void quickbook_output_detail_member(class_or_struct const& cos, std::stringstream ss; quickbook_synopsis_short(f, ss); - out << "[section " << ss.str() << "]" << std::endl; + out << "[section:member" << i << " " << ss.str() << "]" << std::endl; out << "[heading Synopsis]" << std::endl; quickbook_synopsis(f, out, true, true);