Skip to content

Fix documentation formatting #3175

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

Conversation

owen-mc-diffblue
Copy link
Contributor

Getting rid of \par in doxygen

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

Copy link
Collaborator

@tautschnig tautschnig left a comment

Choose a reason for hiding this comment

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

Nit picking: in the commit message, could you be more explicit as to why getting rid of \par is a valuable thing to do (my limited Doxygen knowledge makes me guess that \par has nothing to do with parameters, but might just be a paragraph?).

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: f99e3cc).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/87937057

Use `\param` for parameters instead of `\par` (which is for
paragraphs)
@owen-mc-diffblue owen-mc-diffblue force-pushed the owen/doc/doxygen-parameters-in-function-comments branch from f99e3cc to f4aecf2 Compare October 15, 2018 12:34
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: f4aecf2).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/87957629

@johnnonweiler
Copy link
Contributor

LGTM.

@owen-mc-diffblue owen-mc-diffblue merged commit 2490725 into diffblue:develop Oct 17, 2018
@owen-mc-diffblue owen-mc-diffblue deleted the owen/doc/doxygen-parameters-in-function-comments branch October 17, 2018 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants