CODEWITHSUNDEEP
documentationdoxygenrestructuredtext
Ross Rogers
Ross Rogers

Reputation: 24231

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

Conceptually along the lines of restructuredtext, I want to distribute readme files throughout my different source directories and then have Doxygen read and include those readme text files as part of the generated Doxygen output.

How is this done? Or do I need to spoof Doxygen by creating a pseudo C file like:

README.h:

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

Upvotes: 5

Views: 2523

Answers (3)

Tim
Tim

Reputation: 1118

If you create your README as a .md file, like a Bitbucket Readme, it will be included automatically by Doxygen in the Related Pages. You can also set USE_MDFILE_AS_MAINPAGE to a .md file for your front page.

Upvotes: 0

Trivet
Trivet

Reputation: 1

In doxygen.config

Add FILE_PATTERNS = README

Add INPUT = foo_dir

Then add comments to the foo_dir/README

/*!

* opus

* @brief amaze me

* @details do something amazing

*/

namespace README { }

Upvotes: 0

awiebe
awiebe

Reputation: 3836

If you're just using HTML output you can just use the HTML_EXTRA_FILES field of the doxygen configuration file.

If you have a plain text README file just add it to your program directory manually.

You can also spoof a .h file with the tag \mainpage to populate the index (main) page of your doxygen output.

Upvotes: 6

Related Questions