NatSpec for IPriceOracle
pragma solidity 0.4.25;
-/**
- * @title Bitcoin-Ether price oracle interface.
- */
-
+/// @title Bitcoin-Ether price oracle interface.
contract IPriceOracle {
event PriceUpdated(uint128 price, uint256 expiry);
- // Get the current price of one satoshi in wei
- // reverts if the price is invalid due to expiry
+ /// @notice Get the current price of one satoshi in wei
+ /// @dev reverts if the price is invalid due to expiry
function getPrice() external view returns (uint128);
- // Updates the price in terms of x wei : 1 satoshi
+ /// @notice Updates the price in terms of x wei : 1 satoshi
function updatePrice(uint128 x) external;
}
\ No newline at end of file
