summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-05-02 21:01:25 +0200
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2022-05-02 21:01:25 +0200
commit84c28a73e2a7ace8547e892f675bfc497d157bcb (patch)
tree6bcf9a2ff618141b304dd232c9af7fc027b313ef
parenta7752a1ec0372ceeb4ca895342a9070eae03402b (diff)
downloadiced-84c28a73e2a7ace8547e892f675bfc497d157bcb.tar.gz
iced-84c28a73e2a7ace8547e892f675bfc497d157bcb.tar.bz2
iced-84c28a73e2a7ace8547e892f675bfc497d157bcb.zip
Indicate feature-flagged modules in documentation
-rw-r--r--lazy/src/lib.rs2
-rw-r--r--src/lib.rs1
-rw-r--r--src/widget.rs8
3 files changed, 11 insertions, 0 deletions
diff --git a/lazy/src/lib.rs b/lazy/src/lib.rs
index e1b06f74..916f9458 100644
--- a/lazy/src/lib.rs
+++ b/lazy/src/lib.rs
@@ -1,10 +1,12 @@
#![doc(
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
)]
+#![cfg_attr(docsrs, feature(doc_cfg))]
pub mod component;
pub mod responsive;
#[cfg(feature = "pure")]
+#[cfg_attr(docsrs, doc(cfg(feature = "pure")))]
pub mod pure;
pub use component::Component;
diff --git a/src/lib.rs b/src/lib.rs
index e154d9c7..bbc60746 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -196,6 +196,7 @@ pub mod widget;
pub mod window;
#[cfg(feature = "pure")]
+#[cfg_attr(docsrs, doc(cfg(feature = "pure")))]
pub mod pure;
#[cfg(all(not(feature = "glow"), feature = "wgpu"))]
diff --git a/src/widget.rs b/src/widget.rs
index 83df0052..5e2b63fc 100644
--- a/src/widget.rs
+++ b/src/widget.rs
@@ -167,9 +167,11 @@ pub use toggler::Toggler;
pub use tooltip::Tooltip;
#[cfg(feature = "canvas")]
+#[cfg_attr(docsrs, doc(cfg(feature = "canvas")))]
pub use iced_graphics::widget::canvas;
#[cfg(feature = "image")]
+#[cfg_attr(docsrs, doc(cfg(feature = "image")))]
pub mod image {
//! Display images in your user interface.
pub use iced_native::image::Handle;
@@ -182,9 +184,11 @@ pub mod image {
}
#[cfg(feature = "qr_code")]
+#[cfg_attr(docsrs, doc(cfg(feature = "qr_code")))]
pub use iced_graphics::widget::qr_code;
#[cfg(feature = "svg")]
+#[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
pub mod svg {
//! Display vector graphics in your application.
pub use iced_native::svg::Handle;
@@ -192,13 +196,17 @@ pub mod svg {
}
#[cfg(feature = "canvas")]
+#[cfg_attr(docsrs, doc(cfg(feature = "canvas")))]
pub use canvas::Canvas;
#[cfg(feature = "image")]
+#[cfg_attr(docsrs, doc(cfg(feature = "image")))]
pub use image::Image;
#[cfg(feature = "qr_code")]
+#[cfg_attr(docsrs, doc(cfg(feature = "qr_code")))]
pub use qr_code::QRCode;
#[cfg(feature = "svg")]
+#[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
pub use svg::Svg;