Doxygen mainpage example. For other pages, prefix them with the \page command.

Doxygen mainpage example. Also, have a look this answer to another thread: How to include custom files in Doxygen. For example: /** * \mainpage My Project * * This is the main page of the documentation for My Project. For example, in the class description, note the doxygen special command \author. This command behaves similar as \ref in the sense that it creates a reference to a page labeled <name> with the optional link text as specified in the second argument. Feb 29, 2012 · Have a look at the mainpage command. This tag should be placed at the top of the file and should be followed by a brief description of the project. For other pages, prefix them with the \page command. It states that there are three extensions which doxygen classes as additional documentation files: . By default Doxygen will not know about these custom files, so we'll need to let it know through the INPUT attribute in our Doxyfile. dox, . */ Note If the doxygen generated navigation tree shouldn't . doc. com How do I add a main page in doxygen? To add content to the mainpage, use the doxygen special command \mainpage. For the about example add this line to your Doxyfile: See full list on embeddedinventor. To enhance the documentation you produce, there are a variety of doxygen special commands placed inside doxygen comments. How do I add a new line in doxygen? Sep 7, 2024 · 本文将详细介绍如何使用这些Doxygen命令来构建和优化文档的页面和章节结构，确保在项目文档中实现 最佳的 内容组织和展示效果。 1. Jan 24, 2023 · Setting up Doxygen Basic Tags mainpage tag The main page of a Doxygen documentation is specified using the \mainpage tag. txt and . 命令说明 \mainpage：用于定义文档的主页面（主页），通常作为文档的入口点。 \section: 用于创建顶级章节。 The main page (see \mainpage) is typically the root of hierarchy. Files with these extensions do not appear in the file index but can be used to include additional information into your final documentation - very You'll note that the \mainpage command was used, which tells Doxygen to use this page as, well, the main page. wnqcgk yzqabqfu rvimw umlkra clcjn zmnvud vbhk njl rxtlxi rdmvq