![]() ![]() * Please remove comments that are bracketed by. * This comment block is required for all class declarations. * $Header: /nfs/slac/g/glast/ground/cvs/workbook/pages/advanced_doxygen/usingDoxygen.htm,v 1.1.1.1 9 15:03:16 chuckp Exp $ See the SAS Recommendations for Code Documentation for more information. Only deals with how the doxygen comments should be used information that should be included in standard C++ comments is a different matter, and is not addressed JavaDoc style, where special documentation blocks look like:.Qt style, where special documentation blocks look like:.Be used to create normal documentation.The ability to automatically generate and include dependency graphs, inheritance diagrams, and collaborationĭiagrams enable relations between various elements to be visualized. Be configured to extract the code structure from undocumented source files, enabling you to quickly find your way in large sourceĭistributions. ![]() It also supports generating output in RTF (MS-Word), Postscript, hyperlinked PDF, compressed HTML, and Unix man pages. Documentation isĮxtracted directly from the sources, making it is easier to keep documentation consistent with the source code. Reference manual from a set of documented source files. Generate an on-line documentation browser (in HTML) and/or an off-line.For more detailed information - and to download the doxygen program - go to the Doxygen website. This page provides a summary of some of the things you'll need to know. Doxygen is a documentation system which SAS has adopted it as its code documentation tool. ![]()
0 Comments
Leave a Reply. |