Skip to content

Fix Doxygen warnings in files in /util folder #3381

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Nov 13, 2018
Merged

Fix Doxygen warnings in files in /util folder #3381

merged 2 commits into from
Nov 13, 2018

Conversation

johnnonweiler
Copy link
Contributor

Correct a link in /util/README.md and the names of parameters in some comments in json_irep.cpp

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

hannes-steffenhagen-diffblue
hannes-steffenhagen-diffblue approved these changes Nov 13, 2018
View reviewed changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly OK, but one case where the actual parameter name is just bad IMHO

src/util/json_irep.cpp
@@ -19,7 +19,7 @@ Author: Thomas Kiley, [email protected]

/// To convert to JSON from an irep structure by recursively generating JSON
/// for the different sub trees.
/// \param include_comments: when writing JSON, should the comments
/// \param _include_comments: when writing JSON, should the comments
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename this parameter to include_comments instead.

allredj
allredj reviewed Nov 13, 2018
View reviewed changes
Copy link
Contributor

@allredj allredj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✔️
Passed Diffblue compatibility checks (cbmc commit: 30f735b).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/91189670

@johnnonweiler johnnonweiler merged commit 3469b19 into diffblue:develop Nov 13, 2018
@johnnonweiler johnnonweiler deleted the doc/reduce-doxygen-warnings-15 branch November 13, 2018 11:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@allredj allredj allredj left review comments

@tautschnig tautschnig tautschnig approved these changes

@NlightNFotis NlightNFotis NlightNFotis approved these changes

@peterschrammel peterschrammel peterschrammel approved these changes

@hannes-steffenhagen-diffblue hannes-steffenhagen-diffblue hannes-steffenhagen-diffblue approved these changes

@kroening kroening Awaiting requested review from kroening kroening is a code owner

@pkesseli pkesseli Awaiting requested review from pkesseli

@smowton smowton Awaiting requested review from smowton

Assignees

@johnnonweiler johnnonweiler

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@johnnonweiler @tautschnig @NlightNFotis @peterschrammel @allredj @hannes-steffenhagen-diffblue