compute/doc/reference/iterator/zip_iterator.xml

<?xml version="1.0" encoding="utf-8"?>
<header name="boost/compute/iterator/zip_iterator.hpp">
  <namespace name="boost">
    <namespace name="compute">

      <!-- boost::compute::zip_iterator<IteratorTuple> -->
      <class name="zip_iterator">
        <template>
          <template-type-parameter name="IteratorTuple"/>
        </template>

        <purpose>A zip iterator</purpose>

        <description>
          <para>
            The <code>zip_iterator</code> class combines one or more iterators
            into a single iterator object.
          </para>
          <para>
            See also: <functionname>make_zip_iterator()</functionname>
          </para>
        </description>
      </class>

      <!-- boost::compute::make_zip_iterator(IteratorTuple) -->
      <function name="make_zip_iterator">
        <template>
          <template-type-parameter name="IteratorTuple"/>
        </template>
        <type><classname>zip_iterator</classname>&lt;IteratorTuple&gt;</type>
        <parameter name="iterators">
          <paramtype>IteratorTuple</paramtype>
        </parameter>
        <description>
          <para>
            Returns a new <classname>zip_iterator</classname> with
            <code>iterators</code>.
          </para>
        </description>
      </function>
    </namespace>
  </namespace>
</header>