CodeVocabGnomeDoc

gtk-doc

http://www.gtk.org/gtk-doc/ also known as 'kernel-doc' for the Linux Kernel

Function Page

Javadoc style input:

/**
 * {function name}:
 * @param1: description of param 1
 * @param2: description of param 2
 * ...
 * 
 * {Short Description}
 *
 * {Long Description paragraphs}
 *
 * Return value: {description of return}
 *
 **/

Documentation of this at gtk-doc manual code docs syntax

Output html depends on the XSLT stylesheets but does not seem to have all the semantic names recorded in HTML/CSS class names such as for definitions, return values.

A single page describes a sets of functions, called sections in gtk-doc. (C has no modules, namespaces or classes)

Example output http://librdf.org/docs/api/uri.html

The parameters that are available are:

Semantic name	Class name
Function parameters	variablelist
Parameter	parameter

Raw HTML output (anonymised):

<div class="refsect2" lang="en">
<a name="function-name"></a><h3>function_name ()</h3>
<pre class="programlisting"><a class="link" href="document.html#class1-name" title="class1_name">class1_name</a>*         function_name  (<a class="link" href="document.html#class1-name" title="class1_name">class1_name</a> *arg1, unsigned char *arg2);</pre>

<p>
Copy constructor - create a new class1_name object from an existing class1_name object and a local name.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
<td> <a class="link" href="document.html#class1-name" title="class1_name"><span class="type">class1_name</span></a> object
</td>

</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>arg2</code></em> :</span></p></td>
<td> local name to append to URI
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a new <a class="link" href="document.html#class1-name" title="class1_name"><span class="type">class1_name</span></a> object or NULL on failure

</td>
</tr>
</tbody>
</table></div>
</div>