Also, the title ("BACICallbackTable Class" in this case) should be unique as well as this will be listed in modules.html. Doxygen also supports the hardware description language VHDL. To force the reference to a class or method one can use the see command followed by a list of class and method names. Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D. How do I prevent that at a certain place Put a in front of the. Cannot retrieve contributors at this time 148 lines (125 sloc) 5. Doxygen automatically generates a link to the class M圜lass somewhere in the running text. 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. In case of function and class names, Doxygen is smart and will automatically create a link to the documentation of a function or class whenever it is mentioned inside Doxygen comments. doxygen/doc/autolink.doc Go to file Go to fileT Go to lineL Copy path Copy This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. ** BACICallbackTableTemplate BACICallbackTable Class 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: /** I could quickly do this, so please re-assign to me if you want me to. A link to the destructor of the AutolinkTest class: AutolinkTest::Autolink. 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). Go through the RST docs and add :doxy: directives for all the GammaLib classes / functions. A link to the global enumeration type GlobEnum. But I dont see any call graphs for any of my functions or class methods. Javadoc: external links to classes in java. 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. Extracts automatically comments from your Matlab. 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.Under a certain set of conditions, it is extremely possible Doxygen will not generate any documentation for a C++ class.
0 Comments
Leave a Reply. |