I'm using /defgroup to create logical groupings of functions for a C
API. When you define a group, doxygen creates a page for each group and
a modules.html page with a linked list to each group page. I have
several questions about the default doxygen behavior.
1. Can I add documentation to the modules.html page? Since I'm
documenting a C API, I'm grouping by function, and I'd like to say
something "common" to all the function groups. The best place for this
is on the modules.html page.
2. /defgroup takes only a single string without spaces. This string is
used as the URL on the modules.html page to link to a group's
documentation. I'd like to use a phrase as the group name, for example,
"Connectivity Objects". I've tried escaping, quotes, braces, etc., but
the best I can do is something like "Connectivity_Objects". Is there a
way to use a space-separated string for a group name?
3. I currently using 1.2.6 with the OPTIMIZE_OUTPUT_FOR_C tag set to
YES. This has made an improvement in how the documentation is generated,
but there still seem to be some lingering C++ anomalies. For example,
the data fields pages use the form DbArcRec DbObjectUnion::arc. Is this
a bug, or is there another configuration option I can use to better
optimize for C?
I'm quite impressed with doxygen, but my pet peeve is the many built-in,
non-configurable headings and introductory phrases added to the
generated documentation. For example, the use of "Modules" to identify
the groups I've created for this C API seems strange. I realize I can
change the source and recompile, but more configuration options for page
headings and the like would be a significant improvement to an already
awesome application.
Dimitri, has this been suggested or considered previously?
Thanks for any help you might offer.
Irwin Diehl
|
