doc(runtime-c-api) Improve documentation of `wasmer_wasi_generate_imp…

…ort_object_for_version`.
wasmerio · Dec 4, 2019 · 639c81a · 639c81a
1 parent 41ac416
commit 639c81a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/lib/runtime-c-api/src/import/wasi.rs b/lib/runtime-c-api/src/import/wasi.rs
@@ -75,10 +75,12 @@ pub unsafe extern "C" fn wasmer_wasi_generate_import_object(
     .unwrap_or(ptr::null_mut())
 }
 
-/// Creates a WASI import object.
+/// Creates a WASI import object for a specific version.
 ///
 /// This function is similar to `wasmer_wasi_generate_import_object`
 /// except that the first argument describes the WASI version.
+///
+/// The version is expected to be of kind `Version`.
 #[no_mangle]
 pub unsafe extern "C" fn wasmer_wasi_generate_import_object_for_version(
     version: c_uchar,

diff --git a/lib/runtime-c-api/wasmer.h b/lib/runtime-c-api/wasmer.h
@@ -907,10 +907,12 @@ wasmer_import_object_t *wasmer_wasi_generate_import_object(const wasmer_byte_arr
                                                            unsigned int mapped_dirs_len);
 
 /**
- * Creates a WASI import object.
+ * Creates a WASI import object for a specific version.
  *
  * This function is similar to `wasmer_wasi_generate_import_object`
  * except that the first argument describes the WASI version.
+ *
+ * The version is expected to be of kind `Version`.
  */
 wasmer_import_object_t *wasmer_wasi_generate_import_object_for_version(unsigned char version,
                                                                        const wasmer_byte_array *args,

diff --git a/lib/runtime-c-api/wasmer.hh b/lib/runtime-c-api/wasmer.hh
@@ -711,10 +711,12 @@ wasmer_import_object_t *wasmer_wasi_generate_import_object(const wasmer_byte_arr
                                                            const wasmer_wasi_map_dir_entry_t *mapped_dirs,
                                                            unsigned int mapped_dirs_len);
 
-/// Creates a WASI import object.
+/// Creates a WASI import object for a specific version.
 ///
 /// This function is similar to `wasmer_wasi_generate_import_object`
 /// except that the first argument describes the WASI version.
+///
+/// The version is expected to be of kind `Version`.
 wasmer_import_object_t *wasmer_wasi_generate_import_object_for_version(unsigned char version,
                                                                        const wasmer_byte_array *args,
                                                                        unsigned int args_len,