diff --git a/src/interface/IIntegrityToolingV1.sol b/src/interface/IIntegrityToolingV1.sol index 593bdc0..b518e89 100644 --- a/src/interface/IIntegrityToolingV1.sol +++ b/src/interface/IIntegrityToolingV1.sol @@ -19,5 +19,7 @@ interface IIntegrityToolingV1 { /// Declared `view` so an implementation may read storage or an immutable to /// build its answer. A `pure` implementation still conforms, as an override /// may only tighten mutability. + /// @return Every two bytes is a function pointer for an integrity check, + /// positionally indexed by opcode. function buildIntegrityFunctionPointers() external view returns (bytes memory); } diff --git a/src/interface/IOpcodeToolingV1.sol b/src/interface/IOpcodeToolingV1.sol index fedb92e..6b01b10 100644 --- a/src/interface/IOpcodeToolingV1.sol +++ b/src/interface/IOpcodeToolingV1.sol @@ -18,5 +18,7 @@ interface IOpcodeToolingV1 { /// Declared `view` so an implementation may read storage or an immutable to /// build its answer. A `pure` implementation still conforms, as an override /// may only tighten mutability. + /// @return Every two bytes is a function pointer for an opcode + /// implementation, positionally indexed by opcode. function buildOpcodeFunctionPointers() external view returns (bytes memory); } diff --git a/src/interface/IParserToolingV1.sol b/src/interface/IParserToolingV1.sol index b117f78..ec968ab 100644 --- a/src/interface/IParserToolingV1.sol +++ b/src/interface/IParserToolingV1.sol @@ -18,6 +18,8 @@ interface IParserToolingV1 { /// Declared `view` so an implementation may read storage or an immutable to /// build its answer. A `pure` implementation still conforms, as an override /// may only tighten mutability. + /// @return Every two bytes is a function pointer for an operand handler, + /// positionally indexed to match the parse meta. function buildOperandHandlerFunctionPointers() external view returns (bytes memory); /// Builds literal parser function pointers. @@ -31,5 +33,7 @@ interface IParserToolingV1 { /// Declared `view` so an implementation may read storage or an immutable to /// build its answer. A `pure` implementation still conforms, as an override /// may only tighten mutability. + /// @return Every two bytes is a function pointer for a literal parser, + /// dispatched on the first byte(s) of the literal. function buildLiteralParserFunctionPointers() external view returns (bytes memory); } diff --git a/src/interface/ISubParserToolingV1.sol b/src/interface/ISubParserToolingV1.sol index c4479dc..e6fb23b 100644 --- a/src/interface/ISubParserToolingV1.sol +++ b/src/interface/ISubParserToolingV1.sol @@ -17,5 +17,7 @@ interface ISubParserToolingV1 { /// Declared `view` so an implementation may read storage or an immutable to /// build its answer. A `pure` implementation still conforms, as an override /// may only tighten mutability. + /// @return Every two bytes is a function pointer for a sub parser word + /// parser, positionally indexed to match the parse meta. function buildSubParserWordParsers() external view returns (bytes memory); }