Skip to content

Commit f790184

Browse files
committed
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.
1 parent 8fa6f9c commit f790184

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/docblocks.doc

+6-1
Original file line numberDiff line numberDiff line change
@@ -288,11 +288,16 @@ Here is an example of the use of these comment blocks:
288288

289289
\warning These blocks can only be used to document \e members and \e parameters.
290290
They cannot be used to document files, classes, unions, structs,
291-
groups, namespaces and enums themselves. Furthermore, the structural
291+
groups, namespaces, defines and enums themselves. Furthermore, the structural
292292
commands mentioned in the next section
293293
(like <code>\\class</code>) are not allowed
294294
inside these comment blocks.
295295

296+
\warning Don't use this construct with a define as in that cases
297+
(when \ref cfg_macro_expansion "MACRO_EXPANSION" is set to `YES`)
298+
at places where the define is used the defines is replaced including the comment
299+
and this comment is seen as documentation for the last documentable item seen.
300+
296301
\subsubsection docexamples Examples
297302

298303
Here is an example of a documented piece of C++ code using the Qt style:

0 commit comments

Comments
 (0)