After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 775493 - Usage of underscore's in parameter names
Usage of underscore's in parameter names
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.8
Other Linux
: Normal minor
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2016-12-01 21:59 UTC by Michel Megens
Modified: 2018-05-15 13:58 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Michel Megens 2016-12-01 21:59:58 UTC
*Problem description*
Having (double) underscores at both ends of a parameter name is parsed wrongly by doxygen. As far as I can tell from the warning messages it is actually interpreting that the underscores as 'bold text'.

*Possible solutions*
A possible solution would be to turn of any form of markup language parsing for the first argument to the _@param_ tag. Which is something you probably want anyway.

*Example*
Some (compilable) example sources can be found here: https://gist.github.com/bietje/351fea87b4e50e0db8d9864d0b5b52e4#file-doxy-c

*Warnings generated by doxygen*
The following warnings were spit out by doxygen:
warning: argument 'strong' of command @param is not found in the argument list of fs_split_path(const char *__path__)
warning: argument 'path' of command @param is not found in the argument list of fs_split_path(const char *__path__)
warning: argument 'strong' of command @param is not found in the argument list of fs_split_path(const char *__path__)
warning: The following parameters of fs_split_path(const char *__path__) are not documented:
Comment 1 Dimitri van Heesch 2017-01-08 09:25:37 UTC
Confirmed. Should be fixed in the next GIT update.
Comment 2 Dimitri van Heesch 2017-12-25 18:43:39 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.14. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information 
that you think can be relevant (preferably in the form of a self-contained example).