Re: [Evolution-hackers] Adding documentation to Evolution's code

[Matthew Barnes <mbarnes redhat com>]

On Wed, 2006-08-09 at 17:43 +0530, Mayank Jain wrote:
> This documentation can be like a header to functions like...
> 
> /****
> Use - describe the function in 2-3 lines
> Input - input args
> Output - return values
> ****/

Probably want to stick to a format that GTK-Doc [1] can parse.

For example:

/**
 * function_name:
 * @arg1: description of arg1
 * @arg2: description of arg2
 *
 * Description of function, possibly mentioning @arg1 and @arg2,
 * as well as some other #documented_symbol.
 *
 * Return value: description of the result
 **/

The GTK+ and GLib source code have plenty of good examples.

[1] http://www.gtk.org/gtk-doc/

Matthew Barnes