From f790184fa765d633e2dec9e72635838a24e9a5d5 Mon Sep 17 00:00:00 2001 From: albert-github Date: Mon, 24 May 2021 12:53:37 +0200 Subject: 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. --- doc/docblocks.doc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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 \\class) 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: -- cgit v0.12