The Doxygen-generated documentation for a C++ class is missing. Where is it?
Answer:Under a certain set of conditions, it is extremely possible Doxygen will not generate any documentation for a C++ class. This happens if:
Even if the /** * @file * Header file BACI. */ //... /** * The BACICallbackTable class is a templated typedef so there is no actual inline doc generated for it per-se. */ typedef Registrar<int, BACICallback*> BACICallbackTable; Doxygen generates documentation for this in which you must know the name of the file the typedef is defined in (in this case baci.h). This is completely unacceptable. To make this more developer-friendly, the /** * @file * Header file BACI. */ //... /** @defgroup BACICallbackTableTemplate BACICallbackTable Class * The BACICallbackTable class is a templated typedef so there is no actual inline doc generated for it per-se. * @{ * Callback table */ typedef Registrar<int, BACICallback*> BACICallbackTable; /** @} */ 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 For further information on use of any Doxygen tags discussed here, please consult the Doxygen tutorial itself: http://www.stack.nl/~dimitri/doxygen/download.html#latestman -- DavidFugate - 10 Jan 2005 |
Related articles appear here based on the labels you select. Click to edit the macro and add or change labels.
|