doxygen
The display of default parameter values is inconsistent
Describe the bug This technically encompasses several issues, but they're all related from the user perspective. The tl;dr is that the display of default parameter values is inconsistent depending on several factors.
-
The default values will always show in both brief and detailed class member function documentation regardless of the other factors mentioned in the following points.
-
In the documentation for a file with functions at global scope, the default values show in the brief description regardless of where the functions are documented, but values are not displayed in the detailed description if the function is documented in the source file/next to the function's definition.
-
In the documentation for a file with functions inside a namespace, the default values are not shown period.
(*See note after list about missing detailed descriptions) -
In the documentation for a namespace (i.e. seen by following the hyperlinks in the above file) the values are never shown in the brief descriptions of the functions, but are shown for the detailed descriptions if, again, the function is documented in the header file/next to the function's declaration.
A tangential issue, is that in the documentation for a file with functions inside a namespace the detailed descriptions are missing, which is not the case for the documentation page of a file with functions at global scope. I can file for this separately if needed.
I can see this being by design to reduce redundancy or something since the detailed description can be found in the namespace documentation, but I like the idea of having the documentation for everything belonging to that file being found in one place, as the function "belongs" to the file as much as it does the namespace (at least in my mind).
Expected behavior Function default parameter values should appear in every location that a given function signature appears in the generated documentation, unless possibly affected by configuration settings.
To Reproduce Doxygen Default Param Issue MRE.zip
Version Latest stable release from site: 1.9.4 (5d15657a55555e6181a7830a5c723af75e7577e2) Windows x64