Get Going With DocBook: Notes for Hackers
<<< Previous	A tour of some DocBook features	Next >>>

Describing an API

DocBook has a rather detailed way of marking up descriptions of function behaviour. The tag that introduces it is funcsynopsis. Here is an example:

Example 4. Describing a function in a C library API

<funcsynopsis>
  <funcsynopsisinfo>#include <stdlib.h></funcsynopsisinfo>
  <funcdef>double <function>atof</function></funcdef>
  <paramdef>const char *<parameter>nptr</parameter></paramdef>
</funcsynopsis>

Here is how it looks:

#include <stdlib.h>

double atof(const char *nptr);

<<< Previous	Home	Next >>>
Examples and screen snapshots	Up	Tables