\ brief Basic structures used by other FreeCAD components The Base module includes most of the basic functions of FreeCAD, such as : - Console services : printing different kinds of messages to the FreeCAD report view or the terminal - Python interpreter : handles the execution of Python code in FreeCAD - Parameter handling : Management, saving and restoring of user preferences settings - Units : Management and conversion of different units */Īnother example is the file src/Gui/Command.cpp. \ brief Basic structures used by other FreeCAD components The Base module includes most of the basic functions of FreeCAD, such as : - Console services : printing different kinds of messages to the FreeCAD report view or the terminal - Python interpreter : handles the execution of Python code in FreeCAD - Parameter handling : Management, saving and restoring of user preferences settings - Units : Management and conversion of different units */ /* ! \ namespace Base ** \ defgroup BASE Base * \ ingroup CORE It is important that such files are correctly categorized in a group or namespace, for which Doxygen provides some auxiliary commands like \defgroup, \ingroup, and \namespace. dox in many directories in order to provide a description, or examples, of the code there. The FreeCAD project adds several files ending in. doc then Doxygen will parse the comments and build the appropriate documentation, but it will hide this auxiliary file from the file list. 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). Place a special documentation block somewhere else (another file or another location in the same file) and put a "structural command" in the documentation block.See section Special comment blocks in the manual to learn more about these blocks. For file, class and namespace members (variables) it is also allowed to place the documentation directly after the member. Place a special "documentation block" (a commented paragraph) before the declaration or definition of the function, member, class or namespace.The Getting started (Step 3) section of the Doxygen manual mentions the basic ways of documenting the sources.įor members, classes and namespaces there are basically two options: General workflow to produce source code documentation with Doxygen. Visit the source documentation page for instructions on building the FreeCAD documentation, which is also hosted online on the FreeCAD API website. This document gives a brief introduction to Doxygen, in particular how it is used in FreeCAD to document its sources. Visit the Doxygen website to learn more about the system, and consult the Doxygen Manual for the full information. Doxygen is a popular tool for generating documentation from annotated C++ sources it also supports other popular programming languages such as C#, PHP, Java, and Python.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |