style: Unify style for all Doxygen comments#3142
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #3142 +/- ##
========================================
Coverage 82.65% 82.65%
========================================
Files 398 398
Lines 16118 16118
Branches 8443 8443
========================================
Hits 13323 13323
Misses 1674 1674
Partials 1121 1121 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
| std::string | ||
| path; /**< path to the file to load cache from on start and save cache to on shutdown */ | ||
| uint32_t maxAge = 5000; /**< max difference between latest sequence in cache file and DB */ | ||
| path; ///< path to the file to load cache from on start and save cache to on shutdown |
There was a problem hiding this comment.
nit: Didn't we prefer /**< for these?
There was a problem hiding this comment.
In rippled, there are actually more places with ///<.
In clio, there are already many places with ///< too.
So, overall - incosistent.
Both these styles are in their own way good:
/**<uses stars more similar to regular doxygen comments we have///<doesn't require you to clutter the code on the right side, just as our regular doxygen comments
Ans since inline doxygen comments are a bit different, I think it's ok to use / instead of *.
In the end, it's all getting more consistent, and I like not having to worry to close your comment, so I suggest we do it this way.
| * @brief Calls callback on the oracle ledger entry | ||
| If the oracle entry does not contains the price pair, search up to three previous metadata | ||
| objects. Stops early if the callback returns true. | ||
| * If the oracle entry does not contains the price pair, search up to three previous metadata |
There was a problem hiding this comment.
nit: We usually try to separate brief from detail by a space line
| Multi /**< Multiple Senders can exist (copyable). Uses shared_ptr<Guard> for shared ownership. | ||
| */ | ||
| Single, ///< Only one Sender can exist (non-copyable). Uses direct Guard ownership for zero | ||
| ///< overhead. |
There was a problem hiding this comment.
Is it because of this? Alignment looks off now
There was a problem hiding this comment.
Fixed, and I think it reads better than before
2 participants
No description provided.