add doxygen doc for the *_end functions
authorTORRI Vincent <torri@alf94-3-82-66-248-160.fbx.proxad.net>
Mon, 22 Jan 2007 10:40:15 +0000 (11:40 +0100)
committerTORRI Vincent <torri@alf94-3-82-66-248-160.fbx.proxad.net>
Mon, 22 Jan 2007 10:40:15 +0000 (11:40 +0100)
src/c-client.xsl

index d70b8b6..3e2e849 100644 (file)
@@ -950,6 +950,15 @@ authorization from the authors.
         </xsl:choose>
       </function>
       <function type="xcb_generic_iterator_t" name="{$ref}_end">
+        <doc>/**</doc>
+        <doc> * Return the iterator pointing to the last element</doc>
+        <doc> * @param i An <xsl:value-of select="$ref" />_iterator_t</doc>
+        <doc> * @return  The iterator pointing to the last element</doc>
+        <doc> *</doc>
+        <doc> * Set the current element in the iterator to the last element.</doc>
+        <doc> * The member rem is set to 0. The member data points to the</doc>
+        <doc> * last element.</doc>
+        <doc> */</doc>
         <field type="{$ref}_iterator_t" name="i" />
         <l>xcb_generic_iterator_t ret;</l>
         <xsl:choose>