gEDA-dev: [PATCH 2/4] Update doxygen commits for o_selection_add()

Evan Lavelle sa212+geda at cyconix.com
Mon Dec 18 06:55:43 EST 2006


Doxygen trivia:

>   *  \par Selects the given object and does the needed work to make the
>   *  object visually selected.

This creates a headed paragraph with the whole line after '\par' as the 
[bold] heading, and "object visually selected" as an indented para. 
You'd normally just leave a blank line after the '\brief' heading.

> - *  \returns a pointer to the selection list, with the object added.

Not relevant to this function: 'returns' isn't documented, but seems to 
do the right thing. You'd normally use 'return'.

Evan


More information about the geda-dev mailing list