docs

Author: axic

test/utils/wasm_engine.hpp

@@ -61,8 +61,19 @@ class WasmEngine
     virtual Result execute(FuncRef func_ref, const std::vector<uint64_t>& args) = 0;
 };
 
+/// Throws exception if the signature is non-conformant.
+///
+/// A function signature consist of input and output types delimited by a colon. Zero number of
+/// types is allowed. A type is represented with a single character, where `i` means i32, and
+/// `I` means i64.
+///
+/// As an example `iI:i` translates to `(i32, i64) -> (i32)`, `I:` to `(i64) -> void`, etc.
 void validate_function_signature(std::string_view signature);
 
+/// Parses a validated signature and returns a pair of input and output type vectors of type
+/// `ValueType`.
+///
+/// Note that calling `validate_function_signature` first is advised for better error reporting.
 template <typename ValueType, ValueType i32_type, ValueType i64_type>
 std::pair<std::vector<ValueType>, std::vector<ValueType>> translate_function_signature(
     std::string_view signature)