Question

I have a question!

I already have some code, which is being auto-documented by Doxygen. In addition, I want to add a rather long mainpage to this documentation. The page I want to include is in XML, like this page, for example. I know Doxygen supports only a handful of popular tags and not the rest. So how can I embed an xml page into my documentation’s mainpage, or convert it to a dox file that uses doxygen special commands?

Thanks in advance!

Answer 1

Try using the \htmlinclude command. To incorporate the page you link to in your question I saved the source of the page as dox.xml, placed it in the same directory as a minimal test source file and included the following in the source file:

/**
  \mainpage
  \htmlinclude dox.xml
*/

I also had to add the current directory to the EXAMPLE_PATH field of the configuration file since this is where \htmlinclude (and \verbinclude, another useful command) searches for files to include.

There are a number of useful related questions and answers on this site, including:

Add XML file to the file list

Is there a way to embed <script> content into a Doxygen \mainpage section?

How to include custom files in Doxygen