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

[Evan Lavelle <sa212+geda-at-NOSPAMcyconix_dot_com>]

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


_______________________________________________
geda-dev mailing list
geda-dev@moria.seul.org
http://www.seul.org/cgi-bin/mailman/listinfo/geda-dev