[Openais] [PATCH] Convert existing documentation to doxygen format.

Steven Dake sdake at redhat.com
Tue Mar 8 12:06:47 PST 2011


On 03/07/2011 06:33 PM, Angus Salkeld wrote:
> Hi Russell
> 
> Some gneral comments:
> 
> 1)
> I don't think you need all those "\brief" keywords. I think they look
> quite ugly in the code. Below works fine for me and is cleaner.
> 
> /**
>  * this is always a brief
>  *
>  * leave a line and this is the vebose description.
>  */
> 
> 2)
> I think there little point publishing the exec/*.h files. I know you can
> write your own corosync based on these but I think
> these would probably succeed in confusing the reader more than it would help.
> 
> Steven you think any different?
> 

A "developer internals guidebook" would be immensely helpful - as long
as it can be segregated from the external consumable APIs in the
documentation.

I believe doxygen allows this via the ingroup command, but I am no
expert on doxygen as you can tell from the current state of doxygen in
the codebase.


More information about the Openais mailing list