Skip to content

Commit

Permalink
Document the rest of the C API
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
alexcrichton committed Jul 2, 2020
1 parent d72b330 commit a257650
Show file tree
Hide file tree
Showing 4 changed files with 2,659 additions and 182 deletions.
4 changes: 3 additions & 1 deletion crates/c-api/doxygen.conf
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
Loading

0 comments on commit a257650

Please sign in to comment.