fluencelabs/wasmer
1
0
Fork 0
mirror of https://github.com/fluencelabs/wasmer synced 2024-12-13 06:15:33 +00:00
Code Issues Projects Releases Wiki Activity

doc(runtime-c-api) Declare the example as C, so that they are not tested.

Browse Source 
Those examples contain C code. They must not be run by `rustdoc` as
tests.
This commit is contained in:
Ivan Enderlin 2019-03-06 12:02:20 +01:00
parent 365d00979b
commit d709191be1
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lib/runtime-c-api/src/lib.rs
View File

@ -1498,7 +1498,8 @@ fn take_last_error() -> Option<Box<Error>> {
/// bytes needed to store a message. /// bytes needed to store a message.
/// ///
/// # Example /// # Example
/// ``` ///
/// ```c
/// int error_len = wasmer_last_error_length(); /// int error_len = wasmer_last_error_length();
/// char *error_str = malloc(error_len); /// char *error_str = malloc(error_len);
/// ``` /// ```
@ -1517,7 +1518,8 @@ pub extern "C" fn wasmer_last_error_length() -> c_int {
/// Returns `-1` if an error occurs. /// Returns `-1` if an error occurs.
/// ///
/// # Example /// # Example
/// ``` ///
/// ```c
/// int error_len = wasmer_last_error_length(); /// int error_len = wasmer_last_error_length();
/// char *error_str = malloc(error_len); /// char *error_str = malloc(error_len);
/// wasmer_last_error_message(error_str, error_len); /// wasmer_last_error_message(error_str, error_len);

4
lib/runtime-c-api/wasmer.h
View File

@ -417,7 +417,7 @@ wasmer_result_t wasmer_instantiate(wasmer_instance_t **instance,
* This can be used to dynamically allocate a buffer with the correct number of * This can be used to dynamically allocate a buffer with the correct number of
* bytes needed to store a message. * bytes needed to store a message.
* # Example * # Example
* ``` * ```c
* int error_len = wasmer_last_error_length(); * int error_len = wasmer_last_error_length();
* char *error_str = malloc(error_len); * char *error_str = malloc(error_len);
* ``` * ```
@ -430,7 +430,7 @@ int wasmer_last_error_length(void);
* Returns the length of the string in bytes. * Returns the length of the string in bytes.
* Returns `-1` if an error occurs. * Returns `-1` if an error occurs.
* # Example * # Example
* ``` * ```c
* int error_len = wasmer_last_error_length(); * int error_len = wasmer_last_error_length();
* char *error_str = malloc(error_len); * char *error_str = malloc(error_len);
* wasmer_last_error_message(error_str, error_len); * wasmer_last_error_message(error_str, error_len);

4
lib/runtime-c-api/wasmer.hh
View File

@ -333,7 +333,7 @@ wasmer_result_t wasmer_instantiate(wasmer_instance_t **instance,
/// This can be used to dynamically allocate a buffer with the correct number of /// This can be used to dynamically allocate a buffer with the correct number of
/// bytes needed to store a message. /// bytes needed to store a message.
/// # Example /// # Example
/// ``` /// ```c
/// int error_len = wasmer_last_error_length(); /// int error_len = wasmer_last_error_length();
/// char *error_str = malloc(error_len); /// char *error_str = malloc(error_len);
/// ``` /// ```
@ -344,7 +344,7 @@ int wasmer_last_error_length();
/// Returns the length of the string in bytes. /// Returns the length of the string in bytes.
/// Returns `-1` if an error occurs. /// Returns `-1` if an error occurs.
/// # Example /// # Example
/// ``` /// ```c
/// int error_len = wasmer_last_error_length(); /// int error_len = wasmer_last_error_length();
/// char *error_str = malloc(error_len); /// char *error_str = malloc(error_len);
/// wasmer_last_error_message(error_str, error_len); /// wasmer_last_error_message(error_str, error_len);