compute/doc/reference/iterator/buffer_iterator.xml

<?xml version="1.0" encoding="utf-8"?>
<header name="boost/compute/iterator/buffer_iterator.hpp">
  <namespace name="boost">
    <namespace name="compute">
      
      <!-- boost::compute::buffer_iterator<T> -->
      <class name="buffer_iterator">
        <template>
          <template-type-parameter name="T"/>
        </template>

        <purpose>A buffer iterator</purpose>

        <description>
          <para>
            The <code>buffer_iterator</code> class provides a random-access
            iterator for <classname>buffer</classname> objects.
          </para>
          <para>
            See also: <classname>buffer</classname>,
                      <functionname>make_buffer_iterator()</functionname>
          </para>
        </description>
      </class>

      <!-- boost::compute::make_buffer_iterator(buffer, index) -->
      <function name="make_buffer_iterator">
        <template>
          <template-type-parameter name="T"/>
        </template>
        <type><classname>buffer_iterator</classname>&lt;T&gt;</type>
        <parameter name="buffer">
          <paramtype>const <classname>buffer</classname>&amp;</paramtype>
        </parameter>
        <parameter name="index">
          <paramtype>size_t</paramtype>
          <default>0</default>
        </parameter>
        <description>
          <para>
            Returns a new <classname>buffer_iterator</classname> for
            <code>buffer</code> at <code>index</code>.
          </para>
        </description>
      </function>
    </namespace>
  </namespace>
</header>