Question

When I put in a given doxygen comment the command \file, it appears in the file description.

Wen I put the command \mainpage , it appears in the index.html page

If I put both, doxygen only considers the last one used. How can I put the same comment both in the file description and in the main page?

Thanks in advance.

Was it helpful?

Solution

Because of the way doxygen works there is no way to have the same lines of comment be in both the file description and the main page. As the poster states if it is directly under \file it goes in the file description; if it is under \mainpage it goes in the main page.

If you want the same text to appear in multiple places it has to be copied, which is possible using e.g. the \copydoc command. /** \mainpage \copydoc myfile.cpp */ would copy the \file comment from myfile.cpp to the main page.

OTHER TIPS

Look that example of mainpage command.

Licensed under: CC-BY-SA with attribution
Not affiliated with StackOverflow
scroll top