Information
We are currently investigating an issue with the editor of some pages. Please save your work and avoid to create new pages until this banner is gone.
Where can I find the Doxygen-generated documentation on C++ defines?
First check the Global Defines page (found in api/html/globals_defs.html) which can be reached by clicking on the "File Members" link from main.html and then the "Defines" link in the top right-hand corner beneath the ALMA Computing Group logo.
If it's not listed here, there is actually a chance it was not generated at all. You see unlike C++ classes and functions, define macros are only automatically documented if there is a tag located directly above the define. For example, Doxygen would create inline doc for:
/** * Any documentation here is sufficient */ #define ONE 1
but would not generate anything for:
#define ONE 1
ACS makes every effort to ensure that all macros to be used from ALMA developer code are nicely documented, but some may fall through the cracks. If you encounter such a macro, please report this to the acs-discuss@nrao.edu mailing list.
For further information on the use of Doxygen, please consult the Doxygen tutorial itself: http://www.stack.nl/~dimitri/doxygen/download.html#latestman
-- DavidFugate - 10 Jan 2005