diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2007-07-27 08:53:22 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2007-07-27 08:53:22 (GMT) |
| commit | 9343f07a41e764a904f2d8bef3dd6ac967b63989 (patch) | |
| tree | 096d7be65663d2b1088aed9714e8047edf65961d /doc/docblocks.doc | |
| parent | 0424762097d2a6393d3eed4e2e0a7f32041cfa50 (diff) | |
| download | Doxygen-9343f07a41e764a904f2d8bef3dd6ac967b63989.zip Doxygen-9343f07a41e764a904f2d8bef3dd6ac967b63989.tar.gz Doxygen-9343f07a41e764a904f2d8bef3dd6ac967b63989.tar.bz2 | |
Release-1.5.3
Diffstat (limited to 'doc/docblocks.doc')
| -rw-r--r-- | doc/docblocks.doc | 27 |
1 files changed, 21 insertions, 6 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index d5ff845..d364858 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -24,15 +24,21 @@ needs to end up in the generated documentation. For Python code there is a different comment convention, which can be found in section \ref pythonblocks -For each code item there are two types of descriptions, which together -form the documentation: a \e brief description and \e detailed -description, both are optional. -Having more than one brief or detailed description however, is -not allowed. +For each code item there are two (or in some cases three) types of descriptions, +which together form the documentation: a \e brief description and \e detailed +description, both are optional. 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. + +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). As the name suggest, a brief description is a short one-liner, whereas the detailed description provides longer, -more detailed documentation. +more detailed documentation. An "in body" description can also act as a detailed +description or can describe a collection of implementation details. +For the HTML output brief descriptions are also +use to provide tooltips at places where an item is referenced. There are several ways to mark a comment block as a detailed description: <ol> @@ -87,6 +93,15 @@ or Some people like to make their comment blocks more visible in the documentation. For this purpose you can use the following: + +\verbatim +/************************************************ + * ... text + ***********************************************/ +\endverbatim + +or + \verbatim ///////////////////////////////////////////////// /// ... text ... |