|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r82423 - in sandbox-branches/geometry/index/doc: generated html html/geometry_index/r_tree
From: adam.wulkiewicz_at_[hidden]
Date: 2013-01-09 13:41:56
Author: awulkiew
Date: 2013-01-09 13:41:55 EST (Wed, 09 Jan 2013)
New Revision: 82423
URL: http://svn.boost.org/trac/boost/changeset/82423
Log:
Added the rest of generated files.
Added:
sandbox-branches/geometry/index/doc/generated/inserters.qbk (contents, props changed)
sandbox-branches/geometry/index/doc/generated/translator_def.qbk (contents, props changed)
sandbox-branches/geometry/index/doc/generated/translator_index.qbk (contents, props changed)
Text files modified:
sandbox-branches/geometry/index/doc/generated/adaptors.qbk | 2 +-
sandbox-branches/geometry/index/doc/generated/predicates.qbk | 2 +-
sandbox-branches/geometry/index/doc/generated/rtree.qbk | 4 ++--
sandbox-branches/geometry/index/doc/html/geometry_index/r_tree/reference.html | 6 +++---
sandbox-branches/geometry/index/doc/html/index.html | 2 +-
5 files changed, 8 insertions(+), 8 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-09 13:41:55 EST (Wed, 09 Jan 2013)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from xml/group__adaptors.xml]
-[section:group__adaptors Spatial indexes adaptors (boost::geometry::index::adaptors::)]
+[section:group__adaptors Adaptors (boost::geometry::index::adaptors::)]
[table
[[Function][Description]]
[[[link geometry_index.r_tree.reference.group__adaptors.function0 `nearest_queried(DistancesPredicates const &, size_t, Predicates const &)`]][The nearest query index adaptor generator. ]]
Added: sandbox-branches/geometry/index/doc/generated/inserters.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/inserters.qbk 2013-01-09 13:41:55 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,26 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/group__inserters.xml]
+[section:group__inserters Inserters (boost::geometry::index::)]
+[table
+[[Function][Description]]
+[[[link geometry_index.r_tree.reference.group__inserters.function0 `inserter(Container &)`]][Insert iterator generator. ]]
+]
+
+[section:function0 inserter(Container &)]
+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)``
+
+[heading Parameters]
+[table
+[[Type][Name][Description]]
+[[ `Container &` ][ `c` ][The reference to the container (spatial index) to which values will be inserted.]]
+]
+[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-09 13:41:55 EST (Wed, 09 Jan 2013)
@@ -1,6 +1,6 @@
[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
[/ Generated from xml/group__predicates.xml]
-[section:group__predicates Predicates (boost::geometry::index::)]
+[section:group__predicates Spatial predicates (boost::geometry::index::)]
[table
[[Function][Description]]
[[[link geometry_index.r_tree.reference.group__predicates.function0 `empty()`]][Generate empty predicate. ]]
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-09 13:41:55 EST (Wed, 09 Jan 2013)
@@ -95,8 +95,8 @@
[heading Parameters]
[table
[[Type][Name][Description]]
-[[ `parameters_type` ][ `parameters` ][]]
-[[ `translator_type const &` ][ `translator` ][]]
+[[ `parameters_type` ][ `parameters` ][The parameters object. ]]
+[[ `translator_type const &` ][ `translator` ][The translator object.]]
]
[heading Throws]
If allocator default constructor throws.
Added: sandbox-branches/geometry/index/doc/generated/translator_def.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/translator_def.qbk 2013-01-09 13:41:55 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,29 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/structboost_1_1geometry_1_1index_1_1translator_1_1def.xml]
+[section:boost_geometry_index_translator_def boost::geometry::index::translator::def]
+
+'''<indexterm><primary>boost</primary></indexterm><indexterm><primary>geometry</primary></indexterm><indexterm><primary>index</primary></indexterm><indexterm><primary>translator</primary></indexterm><indexterm><primary>def</primary></indexterm>'''
+The default translator.
+
+[heading Description]
+It translates Value object to Indexable object. The default version handles Values which are Indexables. This translator is also specialized for std::pair<Indexable, Second> and boost::tuple<Indexable, ...>.
+
+[heading Header]
+`#include <.hpp>`
+
+[heading Synopsis]
+``template<typename Value>
+struct def
+{
+ // ...
+};
+``
+
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Value`][The Value type which may be translated directly to the Indexable. ]]
+]
+
+[endsect]
+
Added: sandbox-branches/geometry/index/doc/generated/translator_index.qbk
==============================================================================
--- (empty file)
+++ sandbox-branches/geometry/index/doc/generated/translator_index.qbk 2013-01-09 13:41:55 EST (Wed, 09 Jan 2013)
@@ -0,0 +1,48 @@
+[/ Generated by doxygen_xml2qbk, don't change, will be overwritten automatically]
+[/ Generated from xml/classboost_1_1geometry_1_1index_1_1translator_1_1index.xml]
+[section:boost_geometry_index_translator_index boost::geometry::index::translator::index]
+
+'''<indexterm><primary>boost</primary></indexterm><indexterm><primary>geometry</primary></indexterm><indexterm><primary>index</primary></indexterm><indexterm><primary>translator</primary></indexterm><indexterm><primary>index</primary></indexterm>'''
+The index translator.
+
+[heading Description]
+This translator translates from index of an element in an external Container to the Indexable. The container should have operator[](size\u005ftype) defined. Index translator uses translator::def<...> to translate from Container::value\u005ftype to the Indexable which means that it can handle Indexables, std::pairs and boost::tuples stored in an external Container.
+
+[heading Header]
+`#include <.hpp>`
+
+[heading Synopsis]
+``template<typename Container>
+class index
+{
+ // ...
+};
+``
+
+[heading Template parameter(s)]
+[table
+[[Parameter] [Description]]
+[[`Container`][The Container type. ]]
+]
+
+[heading Constructor(s) and destructor]
+[table
+[[Function][Description]]
+[[[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]
+``index(Container const & c)``
+
+[heading Parameters]
+[table
+[[Type][Name][Description]]
+[[ `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-09 13:41:55 EST (Wed, 09 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="id887480"></a><a class="indexterm" name="id887485"></a><a class="indexterm" name="id887490"></a><a class="indexterm" name="id887494"></a>
+ <a class="indexterm" name="id902772"></a><a class="indexterm" name="id902776"></a><a class="indexterm" name="id902781"></a><a class="indexterm" name="id902786"></a>
The R-tree spatial index.
</p>
<h6>
@@ -6956,7 +6956,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="id924198"></a><a class="indexterm" name="id924202"></a><a class="indexterm" name="id924207"></a><a class="indexterm" name="id924212"></a><a class="indexterm" name="id924217"></a>
+ <a class="indexterm" name="id939489"></a><a class="indexterm" name="id939494"></a><a class="indexterm" name="id939499"></a><a class="indexterm" name="id939504"></a><a class="indexterm" name="id939509"></a>
The default translator.
</p>
<h6>
@@ -7030,7 +7030,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="id924428"></a><a class="indexterm" name="id924433"></a><a class="indexterm" name="id924438"></a><a class="indexterm" name="id924442"></a><a class="indexterm" name="id924447"></a>
+ <a class="indexterm" name="id939720"></a><a class="indexterm" name="id939725"></a><a class="indexterm" name="id939729"></a><a class="indexterm" name="id939734"></a><a class="indexterm" name="id939739"></a>
The index translator.
</p>
<h6>
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-09 13:41:55 EST (Wed, 09 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 16:40:37 GMT</small></p></td>
+<td align="left"><p><small>Last revised: January 09, 2013 at 18:40:07 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
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