doc(runtime-c-api) Improve documentation of wasmer_wasi_generate_import_object_for_version.

This commit is contained in:
Ivan Enderlin
2019-12-04 14:38:54 +01:00
parent 0c5021484f
commit 90f3c894c1
3 changed files with 9 additions and 3 deletions

View File

@ -75,10 +75,12 @@ pub unsafe extern "C" fn wasmer_wasi_generate_import_object(
.unwrap_or(ptr::null_mut()) .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` /// This function is similar to `wasmer_wasi_generate_import_object`
/// except that the first argument describes the WASI version. /// except that the first argument describes the WASI version.
///
/// The version is expected to be of kind `Version`.
#[no_mangle] #[no_mangle]
pub unsafe extern "C" fn wasmer_wasi_generate_import_object_for_version( pub unsafe extern "C" fn wasmer_wasi_generate_import_object_for_version(
version: c_uchar, version: c_uchar,

View File

@ -907,10 +907,12 @@ wasmer_import_object_t *wasmer_wasi_generate_import_object(const wasmer_byte_arr
unsigned int mapped_dirs_len); 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` * This function is similar to `wasmer_wasi_generate_import_object`
* except that the first argument describes the WASI version. * 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, wasmer_import_object_t *wasmer_wasi_generate_import_object_for_version(unsigned char version,
const wasmer_byte_array *args, const wasmer_byte_array *args,

View File

@ -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, const wasmer_wasi_map_dir_entry_t *mapped_dirs,
unsigned int mapped_dirs_len); 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` /// This function is similar to `wasmer_wasi_generate_import_object`
/// except that the first argument describes the WASI version. /// 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, wasmer_import_object_t *wasmer_wasi_generate_import_object_for_version(unsigned char version,
const wasmer_byte_array *args, const wasmer_byte_array *args,
unsigned int args_len, unsigned int args_len,