![]() As DoxyDoxygen knows the Doxygen commands, no. To update a comment, press Alt Q (or Super Alt Q on OS X). I agree that this is a sound argument for a libraries that are mean to be distributed without its source (only headers and libs with object code). Update / wrap an existing documentation block. to make Doxygen treat a multi-line C special comment block (i.e. This should be within the same file of course. The common sense tells that the Doxygen comment blocks have to be put in the header files where the classes, structs, enums, functions, declarations are. This could be handy for archiving the generated documentation or if some. If a doxygen comment block ends with a line containing only code or code all code until a line only containing endcode or endcode is added to the. ![]() Doxygen can cross reference documentation and code. I can even make a list: * * item 1 * * item 2 * * item 3 * * \param a this is one input parameter * \param b this is another * \param c and this is the output * * \author L. The new and easiest way is to add one comment block with a cond command at the start and one comment block with a endcond command at the end of the piece of code that should be ignored. When used for analysis, Doxygen uses its parse tree to generate diagrams and charts of the code structure. Our Doxygen configuration file is located in the base package. * I could add many more details here if I chose to do so. Doxygen comment blocks are the public specification of our C API. - /*! \brief Example function * * \details **myfunction()** takes a and b as arguments and miraculously creates c.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |