![]() ![]() If the class has many members - you may consider Use standard C++ comments for those comments you wish * default constructors and destructors, should not be documented as this * Obvious member variables and functions, such as get and set routines and * to provide instructions to developers while writing their code. * 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. This is to allow macro names to appear in the type of function parameters for instance.Īnother difference is that the preprocessor parses, but not actually includes code when it encounters a #include (with the exception of #include found inside. Typical usage is to only expand a user specified set of macros. By default it does not do macro expansion, although it can be configured to expand all macros. The way the preprocessor works differs somewhat from a standard C Preprocessor. The input files mentioned in the configuration file are (by default) fed to the C Preprocessor (after being piped through a user defined filter if available). The function readConfiguration() in src/doxygen.cpp reads the command line options and then calls the configuration parser. For instance: Config_getBool(GENERATE_TESTLIST) returns a reference to a boolean value that is TRUE if the test list was enabled in the configuration file. The argument of these functions is a string naming the option as it appears in the configuration file. The values of these options are available through the global functions Config_getXXX(), where XXX is the type of the option. This parser is also used directly by doxywizard, so it is put in a separate library.Įach configuration option has one of 5 possible types: String, List, Enum, Int, or Bool. The parser itself is written using flex and can be found in src/config.l. The configuration file that controls the settings of a project is parsed and the settings are stored in the singleton class Config in src/config.h. The following sections explain the steps above in more detail. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |