[doxygen] support markdown directory

Doxygen does not directly support Markdown's [toc] syntax. However, you can manually create the directory by following these steps:

Create chapters and subchapters

In Markdown files, use heading tags ( # ) to create chapters and subsections.

Note:

  • The first-level title of the markdown file will be displayed as the page title by doxygen

If you want to rename a page title for a markdown file, you can use the following syntax

 @page my_page My Page
 This is the content of my custom page
  • page_nameis the name of the page that uniquely identifies it within the document.
  • Page Titleis the title of the page and will be displayed in the generated documentation.
  • Page content goes hereis the content of the page, and can contain arbitrary text, markup, and comments.
@page Example_ADC ADC

In this way, what is displayed on the page is ADCthe title, not theExample_ADC

Use when referencing subpages

@subpage Example_ADC

Refers to the page name, not the page title

configure doxygen

Support markdown
insert image description here
configuration HTML output
insert image description here

In this way, Doxygen will generate a tree-structured table of contents based on the title tags in the Markdown file. The generated table of contents will appear in Doxygen-generated HTML or other formatted documentation, not in the Markdown file itself.

おすすめ

転載: blog.csdn.net/tyustli/article/details/131488784