فهرست منبع

Add comments to global type function declarations (#3431)

Benbuck Nason 1 سال پیش
والد
کامیت
0f17a1464e
1فایلهای تغییر یافته به همراه14 افزوده شده و 0 حذف شده
  1. 14 0
      core/iwasm/include/wasm_export.h

+ 14 - 0
core/iwasm/include/wasm_export.h

@@ -1316,9 +1316,23 @@ WASM_RUNTIME_API_EXTERN wasm_valkind_t
 wasm_func_type_get_result_valkind(wasm_func_type_t const func_type,
 wasm_func_type_get_result_valkind(wasm_func_type_t const func_type,
                                   uint32_t result_index);
                                   uint32_t result_index);
 
 
+/**
+ * Get the kind for a global type
+ *
+ * @param global_type the global type
+ *
+ * @return the kind of the global
+ */
 WASM_RUNTIME_API_EXTERN wasm_valkind_t
 WASM_RUNTIME_API_EXTERN wasm_valkind_t
 wasm_global_type_get_valkind(const wasm_global_type_t global_type);
 wasm_global_type_get_valkind(const wasm_global_type_t global_type);
 
 
+/**
+ * Get the mutability for a global type
+ *
+ * @param global_type the global type
+ *
+ * @return true if mutable, false otherwise
+ */
 WASM_RUNTIME_API_EXTERN bool
 WASM_RUNTIME_API_EXTERN bool
 wasm_global_type_get_mutable(const wasm_global_type_t global_type);
 wasm_global_type_get_mutable(const wasm_global_type_t global_type);