Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to get ride of a empty page when using Doxygen to generate markdown user documentation

Tags:

doxygen

Currently I am using Doxygen to generate a user document from a few markdown files. I want to generate a custom navigation tree like the following:

  • Install
  • --Install on macos
  • --Install on windows
  • --Install on linux

And I have 4 markdown pages, here. let's say they are "install.md", "macos.md", "windows.md" and "linux.md".

My install.md file is as follow:

  • @page install
  • @subpage macos
  • @subpage windows
  • @subpage linux

and the "macos.md" , "windows.md" and "linux.md" each has its own page title: such as @page macos , @page windows and @page linux.

The result is very good, but it generate a few empty pages with the file name.

How could I get rid of all these empty page files?

Thanks in advance.

like image 408
0owen Avatar asked Nov 10 '22 09:11

0owen


1 Answers

I looked for ages for a decent solution, and this is what i found:

In your main markdown file (here install.md), define a group, such as:

\defgroup GrpDummyPages HiddenEmpty
@{
@}

Then in your subpages, for intance your 'windows.md', add at the beginning:

\ingroup GrpDummyPages

In your tree view will appeaer a 'modules' section, with sub-category 'HiddenEmpty', which will contain the pages/files where you put the ingroup command.

like image 51
Napseis Avatar answered Jan 04 '23 02:01

Napseis