On Tue, Mar 08, 2011 at 05:00:34PM -0600, Russell Bryant wrote: > On Tue, Mar 8, 2011 at 2:06 PM, Steven Dake <[email protected]> wrote: > > 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. > > You are correct. There are grouping mechanisms, ways to create custom > pages, ways to link to the documentation of files, functions, > variables, groups, ... lots of things. I would propose documenting > everything and having it all in doxygen, but use custom pages, groups, > and the like to create landing pages for external APIs and internal > stuff.
Another simpler option is to run doxygen twice. Once for include/corosync and another time for exec/*.h. This also means that we don't have to do fancy doxygen stuff in the comment blocks. -Angus > > -- > Russell Bryant > _______________________________________________ > Openais mailing list > [email protected] > https://lists.linux-foundation.org/mailman/listinfo/openais _______________________________________________ Openais mailing list [email protected] https://lists.linux-foundation.org/mailman/listinfo/openais
