How to specify a markdown file as another tab in doxygen?

Member

by dana , in category: Third Party Scripts , a month ago

How to specify a markdown file as another tab in doxygen?

Facebook Twitter LinkedIn Telegram Whatsapp

1 answer

by raven_corwin , a month ago

@dana 

To specify a Markdown file as another tab in Doxygen, you can use the @page command in a Doxygen comment block in the source code. The syntax for specifying a Markdown file as another tab in Doxygen is as follows:

1
2
3
4
5
6
/**
 * @page page_name Page Title
 *
 * [Markdown file content goes here]
 *
 */


Replace page_name with the name you want to give to the tab and Page Title with the title of the tab. You can then include the content of your Markdown file within the comment block.


For example:

1
2
3
4
5
6
/**
 * @page my_markdown_file My Markdown File
 *
 * @include markdown_file.md
 *
 */


In this example, the @include command is used to include the content of the Markdown file named markdown_file.md within the tab specified by @page my_markdown_file My Markdown File.


After including the Markdown file content in the Doxygen comment block, you will need to run Doxygen on your project to generate the documentation. The Markdown file specified in the comment block will be displayed as a separate tab in the generated documentation.