Fix Doxygen warnings in goto-programs/ folder #3394
Conversation
Rename parameter in the function declaration to match the name in the function definition, to make Doxygen happier.
Change parameter name from `clas_hierarchy` to `class_hierarchy` in function definition (so that it matches the parameter name in the function declaration and in the Doxygen comment).
johnnonweiler
requested review from
kroening,
peterschrammel,
pkesseli,
smowton and
tautschnig
as code owners
src/goto-programs/goto_convert.cpp
Outdated
| @@ -1974,6 +1974,7 @@ void goto_convert( | |||
| /// \param thread_body: sequence of codet's that can be executed | |||
| /// in parallel. | |||
| /// \param [out] dest: resulting goto-instructions. | |||
| /// \param mode: language mode. | |||
There was a problem hiding this comment.
Language mode (no full stop unless it is a full sentence)
There was a problem hiding this comment.
I was being consistent with the other parameter documentation for this method. I find changing style within the documentation for one function is much more off-putting than having a different style between functions.
I thought people would prefer me not to change the documentation for the other parameters to match the coding standard. Would you prefer me to do that?
|
Following discussion with @peterschrammel, I have now changed the parameter documentation for |
There was a problem hiding this comment.
🚫
This PR failed Diffblue compatibility checks (cbmc commit: f1e368e).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/91239488
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.
|
I believe the test-gen bot failure was a spurious failure because "the cbmc commit has disappeared in the mean time". |
There was a problem hiding this comment.
✔️
Passed Diffblue compatibility checks (cbmc commit: dcd6cd1).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/91244913
Update function parameter documentation, or rename parameters, to fix Doxygen warnings