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

Make Doxygen comment style the same #518

Merged
merged 5 commits into from
Nov 15, 2023
Merged

Make Doxygen comment style the same #518

merged 5 commits into from
Nov 15, 2023

Conversation

k-doering-NOAA
Copy link
Member

What is the feature?

  • Use /** (Javadoc style) as the consistent style for doxygen

How have you implemented the solution?

Modified other versions (including /*! and /**********)
There was one file that I wasn't sure if I should change to using // for c++ comments and /** for doxygen comments.

Does the PR impact any other area of the project?

No

How to test this change

Check github actions pass and documentation can be built.

Developer pre-PR checklist

  • I relied on GitHub actions to 🧪 things for me while I sat on the 🛋️.

Copy link
Contributor

github-actions bot commented Nov 8, 2023

Instructions for code reviewer

Hello reviewer, thanks for taking the time to review this PR!

  • Please use this checklist during your review, checking off items that you have verified are complete!
  • For PRs that don't make changes to code (e.g., changes to README.md or Github actions workflows), feel free to skip over items on the checklist that are not relevant. Remember it is still important to do a thorough review.
  • Then, comment on the pull request with your review indicating where you have questions or changes need to be made before merging.
  • Remember to review every line of code you’ve been asked to review, look at the context, make sure you’re improving code health, and compliment developers on good things that they do.
  • PR reviews are a great way to learn, so feel free to share your tips and tricks. However, for optional changes (i.e., not required for merging), please include nit: (for nitpicking) before making the suggestion. For example, nit: I prefer using a data.frame() instead of a matrix because...
  • Engage with the developer when they respond to comments and check off additional boxes as they become complete so the PR can be merged in when all the tasks are fulfilled. Make it clear when this has been reached by commenting on the PR with something like This PR is now ready to be merged, no changes needed.

Checklist

  • The PR is requested to be merged into the appropriate branch (typically main)
  • The code is well-designed.
  • The functionality is good for the users of the code.
  • Any User Interface changes are sensible and look good.
  • The code isn’t more complex than it needs to be.
  • Code coverage remains high, indicating the new code is tested.
  • The developer used clear names for everything.
  • Comments are clear and useful, and mostly explain why instead of what.
  • Code is appropriately documented (doxygen and roxygen).

@k-doering-NOAA k-doering-NOAA linked an issue Nov 8, 2023 that may be closed by this pull request
1 task
Copy link

codecov bot commented Nov 8, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2478368) 74.58% compared to head (9aab205) 76.10%.

❗ Current head 9aab205 differs from pull request most recent head 90673cf. Consider uploading reports for the commit 90673cf to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #518      +/-   ##
==========================================
+ Coverage   74.58%   76.10%   +1.52%     
==========================================
  Files          38       37       -1     
  Lines        2034     1791     -243     
  Branches      136        0     -136     
==========================================
- Hits         1517     1363     -154     
+ Misses        476      428      -48     
+ Partials       41        0      -41     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@Bai-Li-NOAA Bai-Li-NOAA left a comment

Choose a reason for hiding this comment

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

Thanks for making all those changes.

  • There are a few \*! in the FIMS/vignettes/fims-path-maturity.Rmd that may need to be updated as well.
  • I think FIMS/inst/include/utilities/fims_json.hpp needs to be updated as well and I have updated it through commit 5014dee

@k-doering-NOAA
Copy link
Member Author

@Bai-Li-NOAA thanks so much! I wasn't sure about whether to change the FIMS_json file, so thank you for taking care of that.

I fixed the other 2 issues that you identified (some **/ that should be */ and /*! to /** in the vignette.

Let me know if you think any other changes need to be made!

Copy link
Contributor

@Bai-Li-NOAA Bai-Li-NOAA left a comment

Choose a reason for hiding this comment

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

Looks great!

@Bai-Li-NOAA Bai-Li-NOAA merged commit e5c4588 into main Nov 15, 2023
13 checks passed
@Bai-Li-NOAA Bai-Li-NOAA deleted the doxygen-style-282 branch November 15, 2023 17:15
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.

[Refactor]: Inconsistent doxygen documentation for class members
2 participants