Write missing docs for user_interface module

This commit is contained in:
Héctor Ramón Jiménez 2022-01-12 11:22:57 +07:00
parent c85caff7a5
commit 7ef0259a2c
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
4 changed files with 9 additions and 3 deletions

View file

@ -7,7 +7,7 @@
#![doc( #![doc(
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg" html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
)] )]
//#![deny(missing_docs)] #![deny(missing_docs)]
#![deny(missing_debug_implementations)] #![deny(missing_debug_implementations)]
#![deny(unused_results)] #![deny(unused_results)]
#![forbid(rust_2018_idioms)] #![forbid(rust_2018_idioms)]

View file

@ -31,7 +31,7 @@
#![doc( #![doc(
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg" html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
)] )]
//#![deny(missing_docs)] #![deny(missing_docs)]
#![deny(missing_debug_implementations)] #![deny(missing_debug_implementations)]
#![deny(unused_results)] #![deny(unused_results)]
#![forbid(unsafe_code)] #![forbid(unsafe_code)]

View file

@ -1,3 +1,4 @@
//! Implement your own event loop to drive a user interface.
use crate::event::{self, Event}; use crate::event::{self, Event};
use crate::layout; use crate::layout;
use crate::mouse; use crate::mouse;
@ -568,8 +569,13 @@ impl Default for Cache {
} }
} }
/// The resulting state after updating a [`UserInterface`].
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
pub enum State { pub enum State {
/// The [`UserInterface`] is outdated and needs to be rebuilt.
Outdated, Outdated,
/// The [`UserInterface`] is up-to-date and can be reused without
/// rebuilding.
Updated, Updated,
} }

View file

@ -23,7 +23,7 @@
#![doc( #![doc(
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg" html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
)] )]
//#![deny(missing_docs)] #![deny(missing_docs)]
#![deny(missing_debug_implementations)] #![deny(missing_debug_implementations)]
#![deny(unused_results)] #![deny(unused_results)]
#![deny(unsafe_code)] #![deny(unsafe_code)]