Commit Graph

338 Commits

Author SHA1 Message Date
ee424bbadf doc(runtime-c-api) Improve documentation of wasmer_result_t. 2020-01-20 15:26:52 +01:00
585f5615cf fix(runtime-c-api) Fix imports, and check for null pointer. 2020-01-20 14:36:45 +01:00
77ba77446d doc(runtime-c-api) Improve documentation of wasmer_instance_context_get. 2020-01-20 14:36:11 +01:00
cd3a1064f9 chore(runtime-c-api) Move wasmer_module_import_instantiate to the module module. 2020-01-20 14:25:13 +01:00
384c501c93 doc(runtime-c-api) Improve error functions' documentations. 2020-01-20 14:23:52 +01:00
5931944a21 Add clippy error checking in lint step 2020-01-17 15:47:45 -08:00
430524ce51 Prepare for 0.13.1 release 2020-01-16 14:07:18 -08:00
96f96f5d20 chore(runtime-c-api) Update C/C++ headers. 2020-01-16 12:31:43 +01:00
d42bbb1f06 doc(runtime-c-api) Improve fragment readability in Doxygen. 2020-01-16 12:31:13 +01:00
44a80dc4a0 doc(runtime-c-api) Improve documentation of wasmer_instantiate. 2020-01-16 12:30:26 +01:00
13800872ff doc(runtime-c-api) Improve documentation of wasmer_instance_context_t. 2020-01-16 12:29:33 +01:00
88ca11628a doc(runtime-c-api) Improve documentation of wasmer_instance_t. 2020-01-16 12:29:09 +01:00
798557367a doc(runtime-c-api) Improve documentation of wasmer_validate. 2020-01-16 12:28:42 +01:00
3c996bc821 Prepare for 0.13.0 release 2020-01-15 11:09:47 -08:00
6514e57b6f Merge #760
760: Add Publish_Docs stage, make it push to a fake gh-pages branch for testing whenever master is updated. r=syrusakbary a=nlewycky

bors r-

Co-authored-by: Nick Lewycky <nick@wasmer.io>
Co-authored-by: Syrus <me@syrusakbary.com>
Co-authored-by: Azure Pipelines <azuredevops@microsoft.com>
2020-01-15 12:58:13 +00:00
7a16828e6e fix(runtime-c-api) Fix error message. 2020-01-15 12:50:18 +01:00
d343cd1d2d Improved C-API documentation links 2020-01-15 11:01:48 +01:00
fb06ee33e3 test(runtime-c-api) Rename wasmer_import_trap to wasmer_trap. 2020-01-15 08:47:52 +01:00
ce3fb49b21 Merge branch 'master' into feat-runtime-c-api-import-trap 2020-01-15 08:44:56 +01:00
cd16a7d1a7 chore(runtime-c-api) Update C/C++ headers. 2020-01-15 08:42:17 +01:00
4cdf868a0b doc(runtime-c-api) Explain why code is unreachable in wasmer_trap. 2020-01-15 08:40:36 +01:00
c0b439e66a feat(runtime-c-api) Rename wasmer_import_trap to wasmer_trap. 2020-01-15 08:37:20 +01:00
286e5db370 Remove vestigial debug features from various crates 2020-01-14 13:03:19 -08:00
220bbc9563 Trying to improve docs build pipeline 2020-01-14 13:17:47 +01:00
4099cc1984 Merge #1142
1142: doc(runtime-c-api) Setup Doxygen r=syrusakbary a=Hywan

With @MarkMcCaskey, we discussed generating the documentation of `wasmer-runtime-c-api` with [Doxygen](http://www.doxygen.nl/).

This patch does the following:

1. Set up a `doxyfile`, which is the configuration file for Doxygen.
2. Set up a `doc/header.html` and `doc/footer.html` files, because Doxygen HTML output is… well, not a master piece 😉.
3. Set up a `doc/css/wasmer.css` stylesheet. I tried to mimic Wasmer color scheme. Usually, I'm not a bad designer, but Doxygen HTML output is so “alembic-ed” that it makes customizing the CSS a real challenge for the very short period of time I've.

Anyway, I believe it's an acceptable first step.

To generate the documentation:

```sh
$ doxygen doxyfile
```

And then open `doc/html/index.html`.

It looks like this:

![Screen Shot 2020-01-13 at 15 20 09](https://user-images.githubusercontent.com/946104/72263046-692ea100-3618-11ea-9feb-6dfd3244d375.png)
![Screen Shot 2020-01-13 at 15 20 25](https://user-images.githubusercontent.com/946104/72263072-70ee4580-3618-11ea-941d-fa652bd7f14e.png)
![Screen Shot 2020-01-13 at 15 20 35](https://user-images.githubusercontent.com/946104/72263082-7481cc80-3618-11ea-81e7-f4da7b71d665.png)
![Screen Shot 2020-01-13 at 15 20 57](https://user-images.githubusercontent.com/946104/72263098-78155380-3618-11ea-9cfc-16b7695c9e89.png)

The next step is to publish the documentation on Github Pages, thoughts @syrusakbary?

Co-authored-by: Ivan Enderlin <ivan.enderlin@hoa-project.net>
2020-01-14 08:08:06 +00:00
6dbfa9d4a2 fix(runtime-c-api) Remove duplicated line.
A copy-paste error has been spotted!
2020-01-13 17:11:12 +01:00
7df0bbcc1e doc(runtime-c-api) Setup Doxygen. 2020-01-13 15:14:30 +01:00
176152e7d5 test(runtime-c-api) Remove a hardcoded value. 2020-01-13 07:46:48 +01:00
6e7d5baccc chore(runtime-c-api) Update C/C++ headers. 2020-01-13 07:39:04 +01:00
b494bd860d doc(runtime-c-api) Improve wasmer_import_func_new's documentation. 2020-01-13 07:35:57 +01:00
a506411eb5 doc(runtime-c-api) Improve documentation of wasmer_import_trap. 2020-01-13 07:35:37 +01:00
b45ead289f test(runtime-c-api) Test wasmer_import_trap. 2020-01-13 07:22:03 +01:00
8790f6dbc9 feat(runtime-c-api) Check pointers aren't null in wasmer_import_trap. 2020-01-13 07:20:06 +01:00
4bf3d6dd41 test(runtime-c-api) Test wasmer_import_trap. 2020-01-10 15:14:52 +01:00
684620435f chore(runtime-c-api) Update headers. 2020-01-10 15:14:18 +01:00
35459c2931 feat(runtime-c-api) Implement wasmer_import_trap.
The new `wasmer_import_trap` allows a host function to fail properly
with the Wasmer trapping API.
2020-01-10 15:13:30 +01:00
e913e8928f chore(runtime-c-api) Fix CS. 2020-01-10 15:12:56 +01:00
ec378597f1 chore(runtime-c-api) Update headers. 2020-01-10 14:49:14 +01:00
7b6d8993e1 chore(runtime-c-api) Update C/C++ headers. 2020-01-09 10:17:34 +01:00
67b684ac85 feat(runtime-c-api) Improve DEPRECATED compatibility.
Clang can emulate GNUC or MSVC behaviors. So instead of detecting
whether Clang is used to compile the code, it's better to detect the
targeted features are available.

Code proposed by @nlewycky, thanks!
2020-01-09 10:13:22 +01:00
4f691dde17 chore(runtime-c-api) Update headers. 2020-01-08 15:25:48 +01:00
b31a3dcdec feat(runtime-c-api) Define the DEPRECATED macro.
This PR defines a cross-compiler `DEPRECATED(message)` macro. It must
be used as follows in Rust:

```rust
/// This is a documentation.
/// cbindgen:prefix=DEPRECATED(This is a deprecation message.")
pub extern "C" fn wasmer_foo() -> c_uint {
    42
}
```

It will generate the following C header:

```c
/**
 * This is a documentation.
 */
DEPRECATED("This is a deprecation message.")
unsigned int wasmer_foo();
```

And once this code is used by a C compiler, it will print something
like this (example from Clang):

```
…/test.c:…:…: error: 'wasmer_foo' is deprecated: This is a deprecation message. [-Werror,-Wdeprecated-declarations]
    unsigned int x = wasmer_foo();
                     ^
…/wasmer.h:…:…: note: 'wasmer_foo' has been explicitly marked deprecated here
DEPRECATED("This is a deprecation message.")
^
…/wasmer.h:…:…: note: expanded from macro 'DEPRECATED'
```

This is required for further deprecations.
2020-01-08 15:02:57 +01:00
0274668675 doc(runtime-c-api) Fix a typo. 2020-01-07 14:21:50 +01:00
6a74b7e994 Prepare for 0.12.0 release 2019-12-18 17:24:29 -05:00
6618750ebd Add include guards for WASI APIs in runtime-c-api 2019-12-17 16:25:26 -05:00
bb90cffac9 Address feedback; improve emscripten fn names in C API 2019-12-16 19:43:57 -05:00
a2b47bd591 Update changelog, clean up, fix test 2019-12-16 18:06:37 -05:00
06d4897d11 Merge branch 'master' into feature/emscripten-in-c-api 2019-12-16 13:50:12 -08:00
e86b3941d0 Update Emscripten API layout; expose inner parts to to C API; add test 2019-12-16 15:45:28 -05:00
f1c95a81ab Add foundational emscripten functions and types to C API 2019-12-13 14:02:48 -08:00