Skip to content

Exclude doc/cprover-manual from Doxygen input [blocks: #3258] #3295

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.

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

Merged
merged 1 commit into from
Nov 8, 2018
Merged

Exclude doc/cprover-manual from Doxygen input [blocks: #3258] #3295

merged 1 commit into from
Nov 8, 2018

Conversation

johnnonweiler
Copy link
Contributor

The documentation in the folder doc/cprover-manual was not intended to be included in the Doxygen documentation. It is intended to be the source for a separate website.

  • 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.

src/doxyfile Outdated
@@ -813,7 +813,7 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is
# run.

EXCLUDE = solvers/z3/
EXCLUDE = solvers/z3/ ../doc/cprover-manual
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd personally follow the pattern used for other list variables in this file, and separate the two paths by a backslash and new line pair. I think that makes it more readable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

👍

The documentation in the folder doc/cprover-manual was not intended to
be included in the Doxygen documentation.  It is the source for a
separate website.
@tautschnig tautschnig changed the title Exclude doc/cprover-manual from Doxygen input Exclude doc/cprover-manual from Doxygen input [blocks: #3258] Nov 8, 2018
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.

⚠️
Diffblue compatibility check is currently unavailable.
Please create manual bump.
(cbmc commit: 59c4e6e).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/90723201

@peterschrammel peterschrammel merged commit f33dc9d into diffblue:develop Nov 8, 2018
@peterschrammel peterschrammel deleted the doc/exclude-cprover-manual-folder branch November 8, 2018 15:20
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.

⚠️
Diffblue compatibility check is currently unavailable.
Please create manual bump.
(cbmc commit: 9b9f2be).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/90724541

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants