Merge pull request #763 from wasmx/comments-cleanup

Minor improvements in documentation
wasmx · Mar 17, 2021 · 5d09b85 · 5d09b85
2 parents 06dffc2 + 8ab6dba
commit 5d09b85
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/include/fizzy/fizzy.h b/include/fizzy/fizzy.h
@@ -54,6 +54,10 @@ typedef struct FizzyExecutionResult
 /// @param  args        Pointer to the argument array. Can be NULL iff function has no inputs.
 /// @param  depth       Call stack depth.
 /// @return             Result of execution.
+///
+/// @note
+/// External functions implemented in C++ must be non-throwing, i.e. the effect of any exception
+/// escaping the function is std::terminate being called.
 typedef FizzyExecutionResult (*FizzyExternalFn)(
     void* context, FizzyInstance* instance, const FizzyValue* args, int depth);
 

diff --git a/lib/fizzy/instantiate.cpp b/lib/fizzy/instantiate.cpp
@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include "instantiate.hpp"
-#include "execute.hpp"  // needed for table elements initialization
+#include "execute.hpp"  // needed for implementation of ExecuteFunction for Wasm functions
 #include <algorithm>
 #include <cassert>
 #include <cstring>