-
Notifications
You must be signed in to change notification settings - Fork 8
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
Conversation
Instructions for code reviewerHello reviewer, thanks for taking the time to review this PR!
Checklist
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
There was a problem hiding this 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 theFIMS/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
5014dee
to
6cc898d
Compare
@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 Let me know if you think any other changes need to be made! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great!
What is the feature?
/**
(Javadoc style) as the consistent style for doxygenHow 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