Skip to content
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

fix doxygen comments #5254

Merged
merged 1 commit into from
Jul 11, 2022
Merged

fix doxygen comments #5254

merged 1 commit into from
Jul 11, 2022

Conversation

e-kwsm
Copy link
Contributor

@e-kwsm e-kwsm commented May 2, 2022

For example,

int x;  //! comment for x
int y;

is equivalent to

int x;
//! comment for x
int y;

i.e. that is a Doxygen comment for y; it should be

int x;  //!< comment for x
int y;

https://www.doxygen.nl/manual/docblocks.html#memberdoc

Copy link
Member

@greglandrum greglandrum left a comment

Choose a reason for hiding this comment

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

The code changes look fine to me, but please provide at least a bit of information in the PR description.

@e-kwsm
Copy link
Contributor Author

e-kwsm commented May 15, 2022

For example,

int x;  //! comment for x
int y;

is equivalent to

int x;
//! comment for x
int y;

i.e. that is a Doxygen comment for y; it should be

int x;  //!< comment for x
int y;

https://www.doxygen.nl/manual/docblocks.html#memberdoc

Copy link
Member

@greglandrum greglandrum left a comment

Choose a reason for hiding this comment

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

LGTM

@greglandrum greglandrum added documentation Cleanup Code cleanup and refactoring labels Jul 8, 2022
@greglandrum greglandrum added this to the 2022_09_1 milestone Jul 8, 2022
@greglandrum
Copy link
Member

@e-kwsm I think this is ready to merge. Do you agree?

@e-kwsm
Copy link
Contributor Author

e-kwsm commented Jul 9, 2022

Yes.

@greglandrum greglandrum merged commit 77db9ed into rdkit:master Jul 11, 2022
@greglandrum
Copy link
Member

@e-kwsm thanks for another great contribution!

@e-kwsm e-kwsm deleted the doxygen branch July 13, 2022 08:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Cleanup Code cleanup and refactoring documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants