diff options
| author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-08 10:26:08 +0900 |
|---|---|---|
| committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-08 10:26:08 +0900 |
| commit | 3a9a44bab659b771d09e2367f1e984f6e99fec3f (patch) | |
| tree | 46b012ff0c21ced7096a87bcc4a5f3a6bf146a7b | |
| parent | 885ba724d7ed98d55831bba9a5f963c9ee74676c (diff) | |
| download | hinawa-rs-3a9a44bab659b771d09e2367f1e984f6e99fec3f.tar.gz | |
hinawa: support dox feature to suppress linking at documentation
| -rw-r--r-- | hinawa/Cargo.toml | 6 | ||||
| -rw-r--r-- | hinawa/README.md | 6 |
2 files changed, 12 insertions, 0 deletions
diff --git a/hinawa/Cargo.toml b/hinawa/Cargo.toml index ad44910..8f84aee 100644 --- a/hinawa/Cargo.toml +++ b/hinawa/Cargo.toml @@ -13,6 +13,8 @@ keywords = ["ieee1394", "firewire", "linux", "glib"] license = "MIT" readme = "README.md" repository = "https://github.com/alsa-project/hinawa-rs/" +[package.metadata.docs.rs] +features = ["dox"] [lib] name = "hinawa" @@ -24,3 +26,7 @@ ffi = {package = "hinawa-sys", path = "../hinawa-sys", version = "0.0"} [dev-dependencies] gir-format-check = "^0.1" + +[features] +# To suppress linking to C library when generating documentation. +dox = ["ffi/dox", "glib/dox"] diff --git a/hinawa/README.md b/hinawa/README.md index 434df3c..1aeb5e9 100644 --- a/hinawa/README.md +++ b/hinawa/README.md @@ -30,6 +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 + +* dox + + * Suppress linking to hinawa library when generating documentation. + ## Repository The hinawa crate is the part of ALSA project and maintained by |