Skip to content

Reduce doxygen warnings #3082

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
tautschnig merged 3 commits into from
Oct 2, 2018
Merged

Reduce doxygen warnings #3082

tautschnig merged 3 commits into from
Oct 2, 2018

Conversation

@johnnonweiler
Copy link
Contributor

@johnnonweiler johnnonweiler commented Oct 2, 2018 •
edited by chrisr-diffblue
Loading

This PR includes 3 commits, fixing separate issues, which between them get rid of the first 4 warnings that I see when running doxygen. I think it should be obvious what is changed and why by looking at the individual commits.

  • Each commit message has a non-empty body, explaining why the change was made.
  • My contribution is formatted in line with CODING_STANDARD.md.
  • 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.

John Nonweiler added 3 commits October 2, 2018 08:34
Fix warnings about not-enabled options
053b591 
Doxygen generates warnings about CLANG_ options which were not
enabled at compile time.  Since these options were being set to
their default values, there is no need to set them, so they have
been commented out.
Fix doxygen syntax by adding subsection names
66d271c
Remove redundant doxygen file header
6688c5a 
The doxygen \file tag was included twice, as well as the brief file
description, author and date.  (And the second time, it had an
incorrect filename.)  This commit deletes the second \file comment
block.
allredj
allredj reviewed Oct 2, 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: 6688c5a).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/86618265

@tautschnig tautschnig merged commit 8c4656b into diffblue:develop Oct 2, 2018
@johnnonweiler johnnonweiler deleted the doc/reduce-doxygen-warnings branch October 4, 2018 07:56
@johnnonweiler johnnonweiler mentioned this pull request Oct 8, 2018
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tautschnig tautschnig tautschnig approved these changes

@chrisr-diffblue chrisr-diffblue Awaiting requested review from chrisr-diffblue

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

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

@pkesseli pkesseli Awaiting requested review from pkesseli

+2 more reviewers

@allredj allredj allredj left review comments

@smowton smowton smowton approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@johnnonweiler @smowton @tautschnig @allredj