New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usage of underscore's in parameter names (Origin: bugzilla #775493) #6128

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity minor in component general for ---
Reported in version 1.8.8 on platform Other
Assigned to: Dimitri van Heesch

On 2016-12-01 21:59:58 +0000, Michel Megens wrote:

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:

On 2017-01-08 09:25:37 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next GIT update.

On 2017-12-25 18:43:39 +0000, Dimitri van Heesch wrote:

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).

@doxygen doxygen closed this Jul 2, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment