Reduce Doxygen warnings in goto-instrument #3179
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
added 2 commits
October 12, 2018 17:16
It appears that Doxygen cannot cope with macros with multiline parameters. There was a DEPRECATED macro with a multiline comment explaining which method to use instead, which led to Doxygen producing a warning message and failing to produce the correct documentation. With the message passed to the DEPRECATED macro abbreviated so that it fits in one line, Doxygen can produce the correct documentation. (There is only one instrument_cover_goals() method which takes a goto_programt as its first parameter.)
Doxygen produces warnings if some parameters are documentated and not others, or if there is documentation for parameters which don't exist.
johnnonweiler
requested review from
chrisr-diffblue,
martin-cs and
peterschrammel
as code owners
chrisr-diffblue
approved these changes
Oct 15, 2018
allredj
reviewed
Oct 15, 2018
There was a problem hiding this comment.
This PR failed Diffblue compatibility checks (cbmc commit: 0ff774b).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/87968363
Status will be re-evaluated on next push.
Please contact @peterschrammel, @thk123, or @allredj for support.
Common spurious failures:
- the cbmc commit has disappeared in the mean time (e.g. in a force-push)
- the author is not in the list of contributors (e.g. first-time contributors).
The incompatibility may have been introduced by an earlier PR. In that case merging this
PR should be avoided unless it fixes the current incompatibility.
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.
Reduce Doxygen warnings by updating some parameter documentation, and abbreviating a "deprecated" message (where Doxygen was getting confused by multi-line macro parameters).