![]() An "in body" description can also act as a detailed description or can describe a collection of implementation details. Having more than one brief or detailed description is allowed (but not recommended, as the order in which the descriptions will appear is not specified).Īs the name suggest, a brief description is a short one-liner, whereas the detailed description provides longer, more detailed documentation. For methods and functions there is also a third type of description, the so called "in body" description, which consists of the concatenation of all comment blocks found within the body of the method or function. ![]() For Python, VHDL, Fortran, and Tcl code there are different comment conventions, which can be found in sections Special documentation blocks in Python, Special documentation blocks in VHDL, Special documentation blocks in Fortran, and Documentation blocks in Tcl respectively.įor each code item there are two (or in some cases three) types of descriptions, which together form the documentation: a brief description and detailed description, both are optional. By clicking, you can find a lot of useful information about the classes and methods present in the package calice_userlib.A special documentation block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece of documentation that needs to end up in the generated documentation. For example, open: file:///group/hcal/calice_soft/pro_test/source/calice_userlib/doc/html/index.html in your internet browser (on a FLC machine). You can view it in your favourite browser. There, the file you are interested in is index.html. In the directory you ran doxygen, you will get a directory called html. Suppose you decided yourself for an HTML documentation. This takes a bit, probably you will see some warnings about undocumented methods, etc, which you can ignore in the first stage (you still get the documentation you added). Have fun with it and feel free to modify it according to your needs. Here you can find an example of a Doxyfile with which the above example was generated. Tells what the extension of the html files should be (.htm or. If HTML chosen, the following tells doxygen where to put the html documentation relative to OUTPUT_DIRECTORY:
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |