Reduce Doxygen warnings #3153
Closed
Reduce Doxygen warnings #3153
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 6 commits
October 12, 2018 16:37
Doxygen produces warnings if some parameters are documentated and not others, or if there is documentation for parameters which don't exist.
Before this commit, get_xml_options had the parameters "(const class xmlt &xml, cmdlinet &cmdline)" in the header file, and "(const xmlt &xml, cmdlinet &cmdline)" in the cpp file. Doxygen then produced a warning "no matching class member found". This commit adds a forward declaration "class xmlt;" in the header file, so that both versions of get_xml_options can have identical parameter lists.
Replace 'signed int' with 'int', and 'unsigned int' with 'unsigned', so that .cpp and .h files are consistent, and doxygen doesn't get confused
The doxygen comment in the header file was referring to a parameter which was given a name only in the cpp file, and doxygen was complaining that it could not find the parameter.
Doxygen doesn't seem to be able to handle method parameters such as '_parameters' or '_return_type' properly.
Doxygen was warning that the argument 'type' has muliple @param documentation sections, and producing incorrect documentation.
johnnonweiler
requested review from
NathanJPhillips,
cesaro,
cristina-david,
kroening,
peterschrammel,
pkesseli,
smowton,
tautschnig and
thk123
as code owners
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following on from #3115, this addresses some more of the warnings that are produced when running doxygen. (Note: Unlike the previous PR, these changes are not limited to changes to the documentation. For example, in some cases parameters have been renamed because doxygen couldn't cope with leading underscores.)
This PR addresses some of the issues in java_bytecode, goto-programs, util and cbmc.
Please see the individual commits for details.