diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-14 18:08:30 +0900 |
---|---|---|
committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-14 18:08:30 +0900 |
commit | 26dea2b26ac3dff11cc5d529902d3c5f9e83047b (patch) | |
tree | cf24fcb97eec80a1258f4f6fe83415c79d50e163 | |
parent | 955e8eef70c19c2b6fb4e233b66a60fbbba47cc1 (diff) | |
download | hinawa-rs-26dea2b26ac3dff11cc5d529902d3c5f9e83047b.tar.gz |
hinawa/hinawa-sys: refine description about dox feature
It's for build.rs to cancel usage of system-dep crate to probe dependent
libraries, and automatically enabled for docs.rs.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r-- | hinawa-sys/README.md | 5 | ||||
-rw-r--r-- | hinawa/README.md | 5 |
2 files changed, 6 insertions, 4 deletions
diff --git a/hinawa-sys/README.md b/hinawa-sys/README.md index ade8728..4e46f0b 100644 --- a/hinawa-sys/README.md +++ b/hinawa-sys/README.md @@ -19,11 +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 +## Features * dox - * Suppress linking to hinawa library when generating documentation. + * Suppress probing hinawa library. It's automatically enabled when generating documentation + in docs.rs. ## Repository diff --git a/hinawa/README.md b/hinawa/README.md index cf507ad..eec6f9f 100644 --- a/hinawa/README.md +++ b/hinawa/README.md @@ -30,11 +30,12 @@ The hinawa crate is released under [MIT license](https://spdx.org/licenses/MIT.h The hinawa crate depends on API crates provided by [gtk-rs project](https://gtk-rs.org/) for type/object system, event loop, and dispacher. -## Features for documentation +## Features * dox - * Suppress linking to hinawa library when generating documentation. + * Suppress probing hinawa library. It's automatically enabled when generating documentation + in docs.rs. ## Repository |