How to write readme files that are automatically included in Doxygen output?

Question

Conceptually along restructuredtext , I want to distribute readme files in all different source directories, and then Doxygen read and include these readme text files as part of the generated Doxygen output.

How it's done? Or I need to trick Doxygen by creating a pseudo C file, for example:

README.h:

/** My big long readme file describing how this library was created and how it should be used */ namespace foo_readme { } 

Answer 1

If you just use HTML output, you can simply use the HTML_EXTRA_FILES field in the doxygen configuration file.

If you have a simple README text file, simply add it to the program directory manually.

You can also fake the .h file with the \mainpage tag to populate the main page of your output.

Answer 2

In doxygen.config

Add FILE_PATTERNS = README

Add INPUT = foo_dir

Then add comments to foo_dir / README

/ *!

* opus

* @ brief surprise me

* @ details do something amazing

* /

README namespace {}