diff options
| author | albert-github <albert.tests@gmail.com> | 2021-05-24 10:53:37 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2021-05-24 10:53:37 (GMT) |
| commit | f790184fa765d633e2dec9e72635838a24e9a5d5 (patch) | |
| tree | 88e85b3ec13f356bf26d86acb8d1f1de6bc57e9b | |
| parent | 8fa6f9c282ee328df22b0ba007a407e2c2751bab (diff) | |
| download | Doxygen-f790184fa765d633e2dec9e72635838a24e9a5d5.zip Doxygen-f790184fa765d633e2dec9e72635838a24e9a5d5.tar.gz Doxygen-f790184fa765d633e2dec9e72635838a24e9a5d5.tar.bz2 | |
issue #8563 Link not created and the Doxygen comment is placed in the output improperly
A small warning about the usage of "Putting documentation after members" in case of a define.
| -rw-r--r-- | doc/docblocks.doc | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc index ac81bec..3137663 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -288,11 +288,16 @@ Here is an example of the use of these comment blocks: \warning These blocks can only be used to document \e members and \e parameters. They cannot be used to document files, classes, unions, structs, - groups, namespaces and enums themselves. Furthermore, the structural + groups, namespaces, defines and enums themselves. Furthermore, the structural commands mentioned in the next section (like <code>\\class</code>) are not allowed inside these comment blocks. +\warning Don't use this construct with a define as in that cases + (when \ref cfg_macro_expansion "MACRO_EXPANSION" is set to `YES`) + at places where the define is used the defines is replaced including the comment + and this comment is seen as documentation for the last documentable item seen. + \subsubsection docexamples Examples Here is an example of a documented piece of C++ code using the Qt style: |