fix: calculateParams in OptimizerV3Push3 has no NatSpec after this PR (#735)

Move the orphaned NatSpec block (originally for calculateParams) from
above getLiquidityParams to directly precede calculateParams, and give
getLiquidityParams only its own @inheritdoc block.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
openhands 2026-03-14 06:20:37 +00:00
parent 7aedcc549e
commit 2c849ec456

View file

@ -9,6 +9,22 @@ import {IOptimizer, OptimizerInput} from "./IOptimizer.sol";
* Implements calculateParams with 8 dyadic rational inputs and 4 outputs.
*/
contract OptimizerV3Push3 is IOptimizer {
/**
* @inheritdoc IOptimizer
* @dev Calls calculateParams with zeroed inputs (percentageStaked=0, averageTaxRate=0),
* producing bear-mode defaults: (ci=0, anchorShare=0.3e18, anchorWidth=100, discoveryDepth=0.3e18).
* This contract is a standalone transpiler output without access to on-chain stake data;
* use OptimizerV3 (which inherits Optimizer) for a live deployment with real inputs.
*/
function getLiquidityParams()
external
view
returns (uint256 capitalInefficiency, uint256 anchorShare, uint24 anchorWidth, uint256 discoveryDepth)
{
OptimizerInput[8] memory inputs;
return calculateParams(inputs);
}
/**
* @notice Compute liquidity parameters from 8 dyadic rational inputs.
* @dev capitalInefficiency (ci) is intentionally hardcoded to 0 in both the bear
@ -31,22 +47,6 @@ contract OptimizerV3Push3 is IOptimizer {
* @return anchorWidth Anchor position width in tick units.
* @return discoveryDepth Discovery liquidity density (0..1e18).
*/
/**
* @inheritdoc IOptimizer
* @dev Calls calculateParams with zeroed inputs (percentageStaked=0, averageTaxRate=0),
* producing bear-mode defaults: (ci=0, anchorShare=0.3e18, anchorWidth=100, discoveryDepth=0.3e18).
* This contract is a standalone transpiler output without access to on-chain stake data;
* use OptimizerV3 (which inherits Optimizer) for a live deployment with real inputs.
*/
function getLiquidityParams()
external
view
returns (uint256 capitalInefficiency, uint256 anchorShare, uint24 anchorWidth, uint256 discoveryDepth)
{
OptimizerInput[8] memory inputs;
return calculateParams(inputs);
}
function calculateParams(OptimizerInput[8] memory inputs)
public
pure