When you place a comment block in a file with one of the following extensions. This way of documenting a source file is useful if you just want to add documentation to your project without adding real code. In this case the structural command \file is used to indicate which source file is being documented a structural command \fn indicates that the following code is a function, and the command \brief is used to give a small description of this function. ![]() */ /** \ fn void setName ( const std :: string & ) * \ brief Set the name to the workbench object. */ /** \ fn std :: string name () const * \ brief Returns the name of the workbench object. An alternative is using C++-style comments // with an additional slash, so ///. The special documentation block starts like a C-style comment /* but has an additional asterisk, so /** the block ends with a matching */. This keeps the declaration and documentation close to each other, so it's easy to update the latter one if the first one changes. Usually you'd want to document the code in the header file, just before the class declaration or function prototype. Of course, file members (functions, variables, typedefs, defines) do not need an explicit structural command just putting a documentation block before or after them will work fine.įirst style: documentation block before the code Files can only be documented using the second option, since there is no way to put a documentation block before a file.The advantage of the first option is that you do not have to repeat the name of the entity (function, member, variable, class, or namespace), as Doxygen will analyze the code and extract the relevant information. ![]() See section Documentation at other places in the manual to learn more about structural commands. ![]() A structural command links a documentation block to a certain entity that can be documented (a function, member, variable, class, namespace or file).
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |