[prev in list] [next in list] [prev in thread] [next in thread] 

List:       sr-dev
Subject:    [OpenSER-Devel] code documentation with doxygen
From:       henning.westerholt () 1und1 ! de (Henning Westerholt)
Date:       2007-10-31 16:46:13
Message-ID: 200710311746.13575.henning.westerholt () 1und1 ! de
[Download RAW message or body]

Hello all,

i would like start to add some actual documentation for important functions in 
the doxygen format. I would suggest that we using the "C" syntax of doxygen, 
that is already used within the trunk. 

Example for this syntax:

/**
 * Timeout handler during wait for children exit. 
 * like sig_alarm_kill, but the timeout has occured when cleaning up,
 * try to leave a core for future diagnostics
 * \param signo signal for killing the children
 * \see sig_alarm_kill
 */
static void sig_alarm_abort(int signo) {..}

Existing documentation could be converted to the doxygen format, as in the 
example from main.c given above.

Any objections against documentation with this syntax and format?

Cheers,

Henning


[prev in list] [next in list] [prev in thread] [next in thread]