Fix Doxygen warnings in goto-instrument/wmm folder #3430
Merged
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
johnnonweiler
requested review from
chrisr-diffblue,
martin-cs and
peterschrammel
as code owners
| @@ -145,14 +145,11 @@ unsigned instrumentert::goto2graph_cfg( | |||
| } | |||
|
|
|||
| void instrumentert::cfg_visitort::visit_cfg_function( | |||
| /* value_sets and options */ | |||
There was a problem hiding this comment.
Why do these comments need to be removed? Surely Doxygen should just be ignoring these?
There was a problem hiding this comment.
Ah, apologies - I see they are replaced by Doxygen on the declaration instead. Ignore me :-)
chrisr-diffblue
approved these changes
Nov 16, 2018
Fix Doxygen warnings by adding documentation for some undocumented parameters. Also change documentation format to match the coding standard (including removing comments on parameters in goto2graph.cpp which duplicate documentation in goto2graph.h).
allredj
reviewed
Nov 16, 2018
There was a problem hiding this comment.
✔️
Passed Diffblue compatibility checks (cbmc commit: 3a18c51).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/91645710
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This fixes the remaining Doxygen warnings related to undocumented parameters. (In one case, it simply deletes documentation of a non-existent parameter, in other cases it adds documentation for missing parameters and tidies up the formatting.)