Doxygen manual param

Doxygen will invoke the filter program by executing (via popen()) the command: where is the value of the INPUT_FILTER tag, and is the name of an input file. Doxygen will then use the output that the filter program writes to standard output. If FILTER_PATTERNS is specified, this tag will be ignored. Introduction to Doxygen The Doxygen package contains a documentation system for C++, C, Java, Objective-C, Corba IDL and to some extent PHP, C# and D. It is useful for generating HTML documentation and/or an off-line reference manual from a set of documented source files. Doxygen creates such pages for files automatically, but no content will appear on them for those that only contain manual pages. The @file block should provide useful meta-documentation to assist technical writers; typically, a list of the pages that it contains.

The second part forms a reference manual: Section Features presents an overview of what doxygen can do. Section Doxygen usage shows how to use the doxygen program. Section Doxywizard usage shows how to use the doxywizard program. Section Configuration shows how to fine-tune doxygen, so it generates the documentation you want. For functions one can use the @param command to document the parameters and then use [in], [out], [in,out] to document the direction. For inline documentation this is also possible by starting with the direction attribute, e.g. void foo(int v /** parameter v. Doxygen provides the command \p for indicating that the next word is a parameter to the function. You would use it like so: the \p x and \p y coordinates are used to I believe by default this will be represented using a typewriter font.

The LSST Stack uses Doxygen to build C++ API reference documentation from comment Documentation blocks must use tags such as @see or @param in place of. \exception std::out_of_range parameter is out of range. * \return a character pointer. */. Click here for the corresponding HTML documentation that is. Doxygen reference documentation The Doxygen manual This will enable doxygen to link all parameter types to the declarations every time the type is used.