diff options
author | 2020-01-09 18:31:07 +0100 | |
---|---|---|
committer | 2020-01-09 18:31:07 +0100 | |
commit | 7b278755fc7929633b5771824beac4d39b16e82e (patch) | |
tree | fe3a8a6b0ae82f7fd1fa0c0de34b4b09d0b9edda /wgpu | |
parent | 775500cf1f5a14afacdc0bb6875136a4fd3369a4 (diff) | |
download | iced-7b278755fc7929633b5771824beac4d39b16e82e.tar.gz iced-7b278755fc7929633b5771824beac4d39b16e82e.tar.bz2 iced-7b278755fc7929633b5771824beac4d39b16e82e.zip |
Write missing docs and reenable deny statements
Diffstat (limited to 'wgpu')
-rw-r--r-- | wgpu/src/defaults.rs | 5 | ||||
-rw-r--r-- | wgpu/src/lib.rs | 2 | ||||
-rw-r--r-- | wgpu/src/settings.rs | 6 | ||||
-rw-r--r-- | wgpu/src/widget.rs | 26 |
4 files changed, 38 insertions, 1 deletions
diff --git a/wgpu/src/defaults.rs b/wgpu/src/defaults.rs index 8de8258b..11718a87 100644 --- a/wgpu/src/defaults.rs +++ b/wgpu/src/defaults.rs @@ -1,7 +1,10 @@ +//! Use default styling attributes to inherit styles. use iced_native::Color; +/// Some default styling attributes. #[derive(Debug, Clone, Copy)] pub struct Defaults { + /// Text styling pub text: Text, } @@ -13,8 +16,10 @@ impl Default for Defaults { } } +/// Some default text styling attributes. #[derive(Debug, Clone, Copy)] pub struct Text { + /// The default color of text pub color: Color, } diff --git a/wgpu/src/lib.rs b/wgpu/src/lib.rs index dda4f322..ab14987c 100644 --- a/wgpu/src/lib.rs +++ b/wgpu/src/lib.rs @@ -19,7 +19,7 @@ //! [`wgpu`]: https://github.com/gfx-rs/wgpu-rs //! [WebGPU API]: https://gpuweb.github.io/gpuweb/ //! [`wgpu_glyph`]: https://github.com/hecrj/wgpu_glyph -//#![deny(missing_docs)] +#![deny(missing_docs)] #![deny(missing_debug_implementations)] #![deny(unused_results)] #![deny(unsafe_code)] diff --git a/wgpu/src/settings.rs b/wgpu/src/settings.rs index c6d8369b..dbe81830 100644 --- a/wgpu/src/settings.rs +++ b/wgpu/src/settings.rs @@ -1,4 +1,10 @@ +/// The settings of a [`Renderer`]. +/// +/// [`Renderer`]: struct.Renderer.html #[derive(Debug, Clone, Copy, PartialEq, Eq, Default)] pub struct Settings { + /// The bytes of the font that will be used by default. + /// + /// If `None` is provided, a default system font will be chosen. pub default_font: Option<&'static [u8]>, } diff --git a/wgpu/src/widget.rs b/wgpu/src/widget.rs index e0f56594..e3edda0b 100644 --- a/wgpu/src/widget.rs +++ b/wgpu/src/widget.rs @@ -1,3 +1,12 @@ +//! Use the widgets supported out-of-the-box. +//! +//! # Re-exports +//! For convenience, the contents of this module are available at the root +//! module. Therefore, you can directly type: +//! +//! ``` +//! use iced_wgpu::{button, Button}; +//! ``` pub mod button; pub mod checkbox; pub mod container; @@ -6,3 +15,20 @@ pub mod radio; pub mod scrollable; pub mod slider; pub mod text_input; + +#[doc(no_inline)] +pub use button::Button; +#[doc(no_inline)] +pub use checkbox::Checkbox; +#[doc(no_inline)] +pub use container::Container; +#[doc(no_inline)] +pub use progress_bar::ProgressBar; +#[doc(no_inline)] +pub use radio::Radio; +#[doc(no_inline)] +pub use scrollable::Scrollable; +#[doc(no_inline)] +pub use slider::Slider; +#[doc(no_inline)] +pub use text_input::TextInput; |