docs: Adds additional docs to internal _read function

chronicleprotocol · Apr 16, 2024 · 8a2f583 · 8a2f583
1 parent b0219d3
commit 8a2f583
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/Aggor.sol b/src/Aggor.sol
@@ -187,6 +187,10 @@ contract Aggor is IAggor, IToll, Auth {
     ///
     /// @dev Note that the value's age is always block.timestamp except if the
     ///      value itself is invalid.
+    ///
+    /// @return uint128 Aggor's current value.
+    /// @return uint The value's age.
+    /// @return Status The status information.
     function _read() internal view returns (uint128, uint, Status memory) {
         // Read Chronicle and Chainlink oracles.
         (bool okChr, uint128 valChr) = _readChronicle();