It is used in conjunction with the \defgroup tag to create a hierarchical structure for the documentation, making it easier to navigate and understand. In Doxygen, the \addtogroup tag is used to add a function, variable, or other element to an existing group. The \defgroup tags are used to create a hierarchical structure for the documentation, which can be displayed in the navigation tree, making it easier to navigate and understand. * This function adds two numbers and return the result. Then you can use \ingroup group_name to specify that a function, variable, or other element belongs to a particular group. * This group contains a variety of mathematical functions, including basic operations like addition and subtraction, as well as more advanced functions like trigonometry and calculus. * \brief A collection of mathematical functions * \defgroup math_functions Math Functions The basic syntax for the \defgroup tag is: /** It is used to create a hierarchical structure for the documentation, making it easier to navigate and understand. In Doxygen, the \defgroup tag is used to group related functions, variables, or other elements together in the documentation. * This file contains external functions used in the project and is not included in the project but is related and should be in the documentation. * \brief Contains external functions used in the project You can also use \file command to specify a file that is not included in the project but is related and should be in the documentation. * This file contains the main function for the program, which is responsible for setting up and running the program. * \brief Contains the main function for the program The basic syntax for the \file tag is: /** The tag should be placed at the top of the file, before any code or other documentation. In Doxygen, the \file tag is used to provide documentation for a specific file. * This is a new named page, you can access it by clicking on the link in the navigation tree. You can also use \page command to create a new named page, for example /** If the doxygen generated navigation tree shouldn't have multiple names for index.html, the name used in mainpage tag must be same as the name in Doxygen Project Title. * This is the main page of the documentation for My Project. This tag should be placed at the top of the file and should be followed by a brief description of the project. The main page of a Doxygen documentation is specified using the \mainpage tag. Setting up Doxygen Basic Tags mainpage tag
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |