T0b1/wasmtime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document the rest of the C API (#1959)

Browse Source 
This commit fills out documentation for all remaining functions in the C
API, and additionally enables "warn if undocumented" which will fail CI
since warnings are also treated as errors.
This commit is contained in:
Alex Crichton
2020-07-02 09:26:10 -05:00
committed by GitHub
parent 8e257e731e
commit 47a218f908
4 changed files with 2659 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
crates/c-api/doxygen.conf
View File

@@ -778,7 +778,7 @@ WARNINGS = YES
# will automatically be disabled.
# The default value is: YES.
WARN_IF_UNDOCUMENTED = NO
WARN_IF_UNDOCUMENTED = YES
# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some parameters
@@ -901,7 +901,9 @@ EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS = assertions \
WASM_DECLARE_* \
WASM_API_EXTERN \
WASI_API_EXTERN \
WASMTIME_DECLARE_OWN \
WASI_DECLARE_OWN \
WASMTIME_CONFIG_PROP \
own