doxygen

How to include custom files in Doxygen


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.


Solution

  • 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.