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:
Mayukha Vadari
2026-10-05 15:47:04 +01:00
parent 558e381d7c
commit 712d243d0e

View File

@@ -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