From 9f8b74adf98dfa723693e688a287259ae20e7ea4 Mon Sep 17 00:00:00 2001
From: link2xt <link2xt@testrun.org>
Date: Tue, 24 Jan 2023 10:59:29 +0000
Subject: [PATCH] Add missing ephemeral.rs documentation

---
 src/ephemeral.rs | 19 ++++++++++++++++---
 1 file changed, 16 insertions(+), 3 deletions(-)

diff --git a/src/ephemeral.rs b/src/ephemeral.rs
index 0e8dfdf7a..72573b925 100644
--- a/src/ephemeral.rs
+++ b/src/ephemeral.rs
@@ -62,8 +62,6 @@
 //! the database entries which are expired either according to their
 //! ephemeral message timers or global `delete_server_after` setting.
 
-#![allow(missing_docs)]
-
 use std::cmp::max;
 use std::convert::{TryFrom, TryInto};
 use std::num::ParseIntError;
@@ -88,13 +86,25 @@ use crate::sql::{self, params_iter};
 use crate::stock_str;
 use crate::tools::{duration_to_str, time};
 
+/// Ephemeral timer value.
 #[derive(Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize)]
 pub enum Timer {
+    /// Timer is disabled.
     Disabled,
-    Enabled { duration: u32 },
+
+    /// Timer is enabled.
+    Enabled {
+        /// Timer duration in seconds.
+        ///
+        /// The value cannot be 0.
+        duration: u32,
+    },
 }
 
 impl Timer {
+    /// Converts epehmeral timer value to integer.
+    ///
+    /// If the timer is disabled, return 0.
     pub fn to_u32(self) -> u32 {
         match self {
             Self::Disabled => 0,
@@ -102,6 +112,9 @@ impl Timer {
         }
     }
 
+    /// Converts integer to ephemeral timer value.
+    ///
+    /// 0 value is treated as disabled timer.
     pub fn from_u32(duration: u32) -> Self {
         if duration == 0 {
             Self::Disabled