Doxygen seems oriented toward documenting a library or API. I'm finding
awkwardness in trying to use it for an application.
The main program creates a `man` page with .c in the name. That's not
customary for an application program. The headers for the .c file also include
that suffix. I don't see a way to separate the documentation of the source
code from the application usage documentation.
I also want to document which programs are in a package and how they are to be
used together. I created a file only for a document, had it create a Group,
included information about the various programs, and had each program @ingroup
themselves and insert some additional info at the bottom of the Group. This
info did show up as a Module -- I did have to add the doc file to Doxyfile
(there is no .dox suffix recognition) early in the list or the Group was not
defined. But the Files page shows this doc-only file, and looking at the
source code shows only one blank line (I start the file with a Doxy comment).
|
