mirror of
https://github.com/XRPLF/rippled.git
synced 2026-10-11 14:18:07 +00:00
Document reserveCount parameters and return value
reserveCount() had no params to document but was missing an @return tag describing what the reserve count means.
This commit is contained in:
@@ -40,6 +40,10 @@ public:
|
||||
* size of its PriceDataSeries.
|
||||
*
|
||||
* @throws std::logic_error if exists() is false.
|
||||
*
|
||||
* @return The number of owner reserves: kMinOracleReserveCount, or
|
||||
* kMaxOracleReserveCount if the PriceDataSeries size exceeds
|
||||
* kOracleReserveCountThreshold.
|
||||
*/
|
||||
[[nodiscard]] std::uint32_t
|
||||
reserveCount() const
|
||||
|
||||
Reference in New Issue
Block a user