summaryrefslogtreecommitdiff
path: root/libs/proto/doc/reference/functional/range/rbegin.xml
diff options
context:
space:
mode:
Diffstat (limited to 'libs/proto/doc/reference/functional/range/rbegin.xml')
-rw-r--r--libs/proto/doc/reference/functional/range/rbegin.xml73
1 files changed, 73 insertions, 0 deletions
diff --git a/libs/proto/doc/reference/functional/range/rbegin.xml b/libs/proto/doc/reference/functional/range/rbegin.xml
new file mode 100644
index 0000000000..ac634d29b7
--- /dev/null
+++ b/libs/proto/doc/reference/functional/range/rbegin.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ Copyright 2012 Eric Niebler
+
+ Distributed under the Boost
+ Software License, Version 1.0. (See accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ -->
+<header name="boost/proto/functional/range/rbegin.hpp">
+ <para>Includes Proto callable <code><classname>boost::proto::functional::rbegin</classname></code>.</para>
+
+ <namespace name="boost">
+ <namespace name="proto">
+ <namespace name="functional">
+
+ <!-- proto::functional::rbegin -->
+ <struct name="rbegin">
+ <purpose>A <conceptname>PolymorphicFunctionObject</conceptname> type that invokes the
+ <code>boost::rbegin()</code> accessor function on its arguments.</purpose>
+ <description>
+ <para>
+ A <conceptname>PolymorphicFunctionObject</conceptname> type that invokes the
+ <code>boost::rbegin()</code> accessor function on its arguments.</para>
+ </description>
+ <inherit>
+ <type><classname>proto::callable</classname></type>
+ </inherit>
+ <struct-specialization name="result">
+ <template>
+ <template-type-parameter name="This"/>
+ <template-type-parameter name="Range"/>
+ </template>
+ <specialization>
+ <template-arg>This(Range)</template-arg>
+ </specialization>
+ <inherit>
+ <type>boost::range_reverse_iterator&lt;
+ typename boost::remove_reference&lt;Range&gt;::type
+ &gt;</type>
+ </inherit>
+ </struct-specialization>
+ <method-group name="public member functions">
+ <method name="operator()" cv="const">
+ <type>typename boost::range_reverse_iterator&lt; Range &gt;::type</type>
+ <template>
+ <template-type-parameter name="Range"/>
+ </template>
+ <parameter name="rng">
+ <paramtype>Range &amp;</paramtype>
+ </parameter>
+ <returns>
+ <para><code>boost::rbegin(rng)</code></para>
+ </returns>
+ </method>
+ <method name="operator()" cv="const">
+ <type>typename boost::range_reverse_iterator&lt; Range const &gt;::type</type>
+ <template>
+ <template-type-parameter name="Range"/>
+ </template>
+ <parameter name="rng">
+ <paramtype>Range const &amp;</paramtype>
+ </parameter>
+ <returns>
+ <para><code>boost::rbegin(rng)</code></para>
+ </returns>
+ </method>
+ </method-group>
+ </struct>
+
+ </namespace>
+ </namespace>
+ </namespace>
+</header>