CODEWITHSUNDEEP
c++documentationdoxygendocumentation-generation
myWallJSON
myWallJSON

Reputation: 9512

Doxygen: how to create documentation a chapter (for pdf) and how it would look in html?

So I have this little project of mine and I made it so that some of my servers automatically generate doxygen documentation in PDF form and HTML. When I look at pdf I see:

enter image description here

and when I look at HTML I see:

enter image description here

This means that main page I defined here with something like /*! @mainpage CF Cloud Observer Server ... is created.

I wonder how to create a chapter that would start after main documentation page (CF Cloud Observer Server chapter) and will not be part of it (say with tutorials called CF CO Tutorials after CF Cloud Observer Server chapter before Module Documentation)?

Upvotes: 1

Views: 3848

Answers (1)

DRH
DRH

Reputation: 8356

You can use the \page command to create any number of additional pages. For example:

/**
 * \page tutorials CF CO Tutorials
 * A page containing Tutorial information.
 */

If you did want to create a sub page for a section, you can do that as well. In that case, you would specify the subpages in the parent page using the \subpage command, something like:

/**
 * \page tutorials CF CO Tutorials
 * A page containing Tutorial information.
 *
 * \subpage tutorial1
 */

/**
 * \page tutorial1 Tutorial 1
 * A subpage covering Tutorial 1
 */

In this case, Tutorial 1 would now show up as a subpage of CF CO Tutorials.

You can find more information about the \page, \subpage commands as well as the related \section and \subsection commands here.

Upvotes: 2

Related Questions