From 7ef0259a2cb7116496f438266a00b73d482eff8a Mon Sep 17 00:00:00 2001
From: Héctor Ramón Jiménez <hector0193@gmail.com>
Date: Wed, 12 Jan 2022 11:22:57 +0700
Subject: Write missing docs for `user_interface` module

---
 native/src/lib.rs            | 2 +-
 native/src/user_interface.rs | 6 ++++++
 2 files changed, 7 insertions(+), 1 deletion(-)

(limited to 'native')

diff --git a/native/src/lib.rs b/native/src/lib.rs
index c527a69a..a5526e6d 100644
--- a/native/src/lib.rs
+++ b/native/src/lib.rs
@@ -31,7 +31,7 @@
 #![doc(
     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(unused_results)]
 #![forbid(unsafe_code)]
diff --git a/native/src/user_interface.rs b/native/src/user_interface.rs
index b6bed5ed..4b1194be 100644
--- a/native/src/user_interface.rs
+++ b/native/src/user_interface.rs
@@ -1,3 +1,4 @@
+//! Implement your own event loop to drive a user interface.
 use crate::event::{self, Event};
 use crate::layout;
 use crate::mouse;
@@ -568,8 +569,13 @@ impl Default for Cache {
     }
 }
 
+/// The resulting state after updating a [`UserInterface`].
 #[derive(Debug, Clone, Copy)]
 pub enum State {
+    /// The [`UserInterface`] is outdated and needs to be rebuilt.
     Outdated,
+
+    /// The [`UserInterface`] is up-to-date and can be reused without
+    /// rebuilding.
     Updated,
 }
-- 
cgit