How can Doxygen be used to create user manuals? The website says it can be done, but I am not sure how. Are there any markup examples for this situation?
A:
A manual page can be created using the \page tag in a blank file with a source code file extension (.c, .java et cetera):
/*! \page example Example
\This is an example user manual page...
*/
But this doesn't solve the issue of inter-linking manual pages and creating a table of contents, for example.
john
2010-10-20 02:48:51
A:
I interpret "User manual" as a structured text with sections, subsections and paragraphs.
The main useful tags are @page, @section, @subsection and @par. You need only one Doxygen @page for the whole user manual.
For examples, you can explore Doxygen documentation. A good starting point is the description of the @page command.
You can insert diagrams with @dot or @dotfile tags, provided that you describe your graph using Graphviz language.
Enable LATEX_OUTPUT for a nice rendering.
mouviciel
2010-10-20 08:02:02
A:
User manuals are fancy picture driven booklets that nobody reads, but you need to have them anyway so your product will look more 'complete'.
Doxygen CAN'T produce user manuals. It is meant to produce source code 'manuals' and are useful only for publishers of ready made software components.
If you want to produce TECHNICAL manual with it, however, that's the different thing and then - go for it.
Daniel Mošmondor
2010-10-20 08:41:20