![]() Also, the title ("BACICallbackTable Class" in this case) should be unique as well as this will be listed in modules.html. Which produces an HTML file named BACICallbackTableTemplate.html and this file includes Doxygen documentation on everything between the first encountered and the closing Please ensure the name you give immediately after the defgroup tag does not conflict with other names defined in your header files. Additional Variables with Important Impacts Doxygen Documentation Pitfalls. ** BACICallbackTableTemplate BACICallbackTable Class Crash Course on Documentation with Doxygen. To make this more developer-friendly, the defgroup tag is used: /** ![]() * The BACICallbackTable class is a templated typedef so there is no actual inline doc generated for it per-se.ĭoxygen generates documentation for this in which you must know the name of the file the typedef is defined in (in this case baci.h). For example, say you have a header file which includes the following: /** In as such, ACS uses the defgroup tag provided by Doxygen on the typedef which in turn places a link to the newly created class in modules.html (linked to from main.html). ![]() The header file in which this typedef is defined does not utilize the file tag.Įven if the file tag is used correctly, the documentation Doxygen produces for the class is quite hard to find to say the least.This is commonly done in the ACS BACI module where classes are created by using a typedef in conjunction with another class which has template parameters. The class is created by using a typedef.That is just the short version of the answer. so that they can be displayed in formats like HTML, Hyperlinked PDF, etc. Under a certain set of conditions, it is extremely possible Doxygen will not generate any documentation for a C++ class. Doxygen works by taking the comments which are specifically formatted according to Doxygen’s syntax, when you run this tool, it will parse out the documentation details from comments which follow the special Doxygen syntax.
0 Comments
Leave a Reply. |