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

Unify style of comments, improve function description #159

Merged
merged 5 commits into from
Oct 30, 2023

Conversation

jajik
Copy link
Collaborator

@jajik jajik commented Oct 25, 2023

Work in progess but it should give the idea.

close #158

Copy link
Member

@jfclere jfclere left a comment

Choose a reason for hiding this comment

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

Don't remove comments.
The rest looks OK for me.

@rhusar
Copy link
Member

rhusar commented Oct 25, 2023

Don't remove comments. The rest looks OK for me.

Well, the comments are moved from implementation to the header file, that appears correct to me.

@jfclere
Copy link
Member

jfclere commented Oct 25, 2023

Don't remove comments. The rest looks OK for me.

Well, the comments are moved from implementation to the header file, that appears correct to me.

Oops yes that is OK, sorry I didn't read till the end.

@jajik
Copy link
Collaborator Author

jajik commented Oct 25, 2023

Good, thank you both! I'll continue with the rest.

@jajik jajik force-pushed the comments-tweaks branch 3 times, most recently from 52c3cfa to 8df7549 Compare October 26, 2023 13:50
@jajik jajik requested a review from jfclere October 26, 2023 13:56
@jajik
Copy link
Collaborator Author

jajik commented Oct 26, 2023

@jfclere Marking Ready for review.

Comments are updated. I added a Doxyfile and a note into the README about how to build doxygen docs. Once we merge this I will add those docs on the web as Radoslav suggested.

@jajik jajik marked this pull request as ready for review October 26, 2023 14:00
@rhusar rhusar self-assigned this Oct 26, 2023
Copy link
Member

@rhusar rhusar left a comment

Choose a reason for hiding this comment

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

LGTM

@rhusar rhusar merged commit 16c4aee into modcluster:main Oct 30, 2023
7 checks passed
@rhusar
Copy link
Member

rhusar commented Oct 30, 2023

Thanks @jajik for cleaning this up and @jfclere

@jajik
Copy link
Collaborator Author

jajik commented Oct 30, 2023

Thanks!

@jajik jajik deleted the comments-tweaks branch November 23, 2023 08:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unify style of comments before function declaration/definition.
3 participants