More documentation comments

Author: gumb0

include/fizzy/fizzy.h

@@ -75,8 +75,15 @@ void fizzy_free_module(const struct FizzyModule* module);
 /// Takes ownership of module, i.e. @p module is invalidated after this call.
 ///
 /// @param module                   Pointer to module.
-/// @param imported_functions       Pointer to the imported function array.
+/// @param imported_functions       Pointer to the imported function array. Can be NULL iff
+///                                 imported_functions_size equals 0.
 /// @param imported_functions_size  Size of the imported function array. Can be zero.
+///
+/// @note
+/// Function expects @a imported_functions to be in the order of imports defined in the module.
+/// No validation is done on the number of functions passed in, nor on their order.
+/// When number of passed functions or their order is different from the one defined by the
+/// module, behaviour is undefined.
 struct FizzyInstance* fizzy_instantiate(const struct FizzyModule* module,
     const struct FizzyExternalFunction* imported_functions, size_t imported_functions_size);
 
@@ -88,6 +95,11 @@ void fizzy_free_instance(struct FizzyInstance* instance);
 /// @param instance     Pointer to module instance.
 /// @param args         Pointer to the argument array. Can be NULL if function has 0 inputs.
 /// @param depth        Call stack depth.
+///
+/// @note
+/// No validation is done on the number of arguments passed in @p args, nor on their types.
+/// When number of passed arguments or their types are different from the ones defined by the
+/// function type, behaviour is undefined.
 FizzyExecutionResult fizzy_execute(
     struct FizzyInstance* instance, uint32_t func_idx, const union FizzyValue* args, int depth);