Update docs
This commit is contained in:
parent
5ee05f3a6b
commit
c5c2a3a3cb
@ -36,7 +36,7 @@ interface IMatteryEnergyStorage : IEnergyStorage {
|
||||
* Therefore, if you want/need to obey [energyFlow], use [extractEnergyChecked]
|
||||
*
|
||||
* General contracts:
|
||||
* * Negative values are not allowed, failing to comply with this contract will result in undefined behavior (worst case) or exception (best case)
|
||||
* * Negative values are not allowed, failing to comply with this contract will result in undefined behavior in worst case or nothing in best case
|
||||
* * Returned value CAN NOT be bigger than requested [howMuch], implementations failing to obey this contract will cause undefined behavior in upstream code.
|
||||
* Upstream code SHOULD NOT check for this contract.
|
||||
*
|
||||
@ -68,7 +68,7 @@ interface IMatteryEnergyStorage : IEnergyStorage {
|
||||
* Therefore, if you want/need to obey [energyFlow], use [receiveEnergyChecked]
|
||||
*
|
||||
* General contracts:
|
||||
* * Negative values are not allowed, failing to comply with this contract will result in undefined behavior (worst case) or exception (best case)
|
||||
* * Negative values are not allowed, failing to comply with this contract will result in undefined behavior in worst case or nothing in best case
|
||||
* * Returned value CAN NOT be bigger than requested [howMuch], implementations failing to obey this contract will cause undefined behavior in upstream code.
|
||||
* Upstream code SHOULD NOT check for this contract.
|
||||
*
|
||||
|
Loading…
Reference in New Issue
Block a user