diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-08 10:24:24 +0900 |
---|---|---|
committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-08 10:24:24 +0900 |
commit | 885ba724d7ed98d55831bba9a5f963c9ee74676c (patch) | |
tree | bcad570cad0702ddd8f8491e9173f817cf775648 | |
parent | 29a4506e78bf7f47ef50c78ec876c1ee72301fc5 (diff) | |
download | hinawa-rs-885ba724d7ed98d55831bba9a5f963c9ee74676c.tar.gz |
hinawa-sys: add comment about dox feature for documentation
-rw-r--r-- | hinawa-sys/Cargo.toml | 1 | ||||
-rw-r--r-- | hinawa-sys/README.md | 6 |
2 files changed, 7 insertions, 0 deletions
diff --git a/hinawa-sys/Cargo.toml b/hinawa-sys/Cargo.toml index 74987a4..1c5567c 100644 --- a/hinawa-sys/Cargo.toml +++ b/hinawa-sys/Cargo.toml @@ -44,4 +44,5 @@ shell-words = "1.0.0" tempfile = "3" [features] +# To suppress linking to C library when generating documentation. dox = [] diff --git a/hinawa-sys/README.md b/hinawa-sys/README.md index 88dcf93..ade8728 100644 --- a/hinawa-sys/README.md +++ b/hinawa-sys/README.md @@ -19,6 +19,12 @@ The hinawa-sys crate is released under [MIT license](https://spdx.org/licenses/M The hinawa-sys crate depends on FFI crates provided by [gtk-rs project](https://gtk-rs.org/) for type/object system, event loop, and dispacher. +## Features for documentation + +* dox + + * Suppress linking to hinawa library when generating documentation. + ## Repository The hinawa-sys crate is the part of ALSA project and maintained by |