1 cdoc is a perldoc-like documentation tool for C.
3 It is very simple to use. Basically you just need to add the following
4 in front of your function prototypes in header files:
6 /* Function: foo - foobar a baz
9 * The @code{foo} function foobars a baz. It takes one parameter, the
10 * pointer to the @code{baz} structure.
12 * @code{foo_p} returns true if the parameter @code{baz} has been foobarred.
14 * See also: @ref{baz(3)}, @ref{frobnicate(3)}.
16 extern void foo (baz *);
17 extern int foo_p (baz *);
19 More advanced examples of the syntax can be found in the c2lib, pthrlib
20 and other packages at http://www.annexia.org/freeware/
22 To turn your header files into manpages, type: cdoc *.h
24 It was written by Richard W.M. Jones (rich@annexia.org).