From c6f8da051506583283cf1f5c439350a6f3d4d96e Mon Sep 17 00:00:00 2001 From: lilly lizard <44878819+lilly-lizard@users.noreply.github.com> Date: Sun, 29 May 2022 12:40:10 +0000 Subject: [PATCH] Document crate `feature`s in library docs (#627) --- ash/Cargo.toml | 2 +- ash/src/lib.rs | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/ash/Cargo.toml b/ash/Cargo.toml index 86d7f84..def1784 100644 --- a/ash/Cargo.toml +++ b/ash/Cargo.toml @@ -20,7 +20,7 @@ default = ["loaded", "debug"] linked = [] # Support searching for the Vulkan loader manually at runtime. loaded = ["libloading"] -# Whether Vulkan structs should implement Debug +# Whether Vulkan structs should implement Debug. debug = [] [package.metadata.release] diff --git a/ash/src/lib.rs b/ash/src/lib.rs index 30add6c..e6f8ddf 100644 --- a/ash/src/lib.rs +++ b/ash/src/lib.rs @@ -33,6 +33,12 @@ //! Load the Vulkan library linked at compile time using [`Entry::linked()`], or load it at runtime //! using [`Entry::load()`], which uses `libloading`. If you want to perform entry point loading //! yourself, call [`Entry::from_static_fn()`]. +//! +//! ## Crate features +//! +//! * **debug** (default): Whether Vulkan structs should implement `Debug`. +//! * **loaded** (default): Support searching for the Vulkan loader manually at runtime. +//! * **linked**: Link the Vulkan loader at compile time. pub use crate::device::Device; pub use crate::entry::Entry;