[Xcb] documentation.
Vincent Torri
vtorri at univ-evry.fr
Wed Nov 22 23:17:02 PST 2006
Hey,
I've tried to add a specific doc for the *_next functions. Here is what
I've done in c-client.xsl:
I've added after line 941 (<function type="void" name="{$ref}_next">) :
<doc>/**
</doc>
<doc> * Get the next element of the iterator
</doc>
<doc> * @param i Pointer to a <xsl:value-of select="$ref"
/>_iterator_t
</doc>
<doc> *
</doc>
<doc> * Get the next element in the iterator. The member rem is
</doc>
<doc> * decreased by one. The member data points to the next
</doc>
<doc> * element. The member index is increased by
sizeof(<xsl:value-of select="$ref" />_t)
</doc>
<doc> */</doc>
and just after the comment <!-- Doxygen for functions in header. --> :
<xsl:apply-templates select="doc">
</xsl:apply-templates>
The output is correct (well, except that there are 2 comments for the
_next functions and that they appear in the .c and .h files)
do you think that it's a good method for the protocol stub api ?
Vincent
More information about the Xcb
mailing list