Menu
I would like to add custom (non-project) files to generate some extra pages with Doxygen.
I am (was actually) unsure how these files should be named and how their content should be formatted.
237
Just list your custom files in the INPUT macro in your doxyfile. You can choose whatever name you find appropriate. Format is text with Doxygen tags.
In DoxyWizard, go to Expert->Input then scroll down to FILE_PATTERNS . Make sure the . cpp extension is listed. If not, insert it into the list.
You can put example source code in a special path defined in the doxygen config under EXAMPLE_PATH , and then insert examples with the @example tag. Doxygen will then generate an extra page containing the source of the example. It will also set a link to it from the class documentation containing the example tag.
How can I make doxygen ignore some code fragment? The new and easiest way is to add one comment block with a \cond command at the start and one comment block with a \endcond command at the end of the piece of code that should be ignored. This should be within the same file of course.
I having been searching quite a lot before I found the answer, so I thought it would be nice to share!
According to this Doxygen gotchas article I finally found that: you need to add a file with the dox extension. Its content should contain C-style comment blocks:
/*! \page My test page contents ... more contents */ Make sure your custom files are placed in a directory which is included in INPUT setting or in the current directory if INPUT is left empty, so these files can be found.
60
Just for completeness: there are 3 possible extensions which doxygen treats as additional documentation files: .dox, .txt, and .doc.
Files which such extension are hidden from the file index. Inside the file you need to put one or more C/C++ style comment blocks.
21
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
