diff src/handle.rs @ 174:9e4ce1631bd3

Dramatically expand documentation.
author Paul Fisher <paul@pfish.zone>
date Tue, 29 Jul 2025 18:58:27 -0400
parents e27c5c667a5a
children
line wrap: on
line diff
--- a/src/handle.rs	Tue Jul 29 16:52:32 2025 -0400
+++ b/src/handle.rs	Tue Jul 29 18:58:27 2025 -0400
@@ -50,7 +50,6 @@
     /// The contents of the environment to set for the logged-in user.
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_getenv: adg, mwg, _std)]
     ///
     #[doc = stdlinks!(3 pam_getenv)]
@@ -61,7 +60,6 @@
     /// A writable map of the environment to set for the logged-in user.
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_putenv: adg, mwg, _std)]
     ///
     #[doc = stdlinks!(3 pam_putenv)]
@@ -76,7 +74,6 @@
     /// by PAM modules only.
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_get_item: mwg, adg, _std)]
     ///
     #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_get_item")]
@@ -87,7 +84,6 @@
     /// Read-write access to PAM Items.
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_set_item: mwg, adg, _std)]
     ///
     #[doc = guide!(adg: "adg-interface-by-app-expected.html#adg-pam_set_item")]
@@ -165,7 +161,6 @@
     /// retrieves the existing item.
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_get_authtok: man7, manbsd)]
     ///
     /// # Example
@@ -190,7 +185,6 @@
     /// This should only be used by a *password-change* module.
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_get_authtok: man7, manbsd)]
     ///
     /// # Example
@@ -205,7 +199,6 @@
     /// Ok(())
     /// # }
     /// ```
-    ///
     #[doc = stdlinks!(3 pam_get_authtok)]
     fn old_authtok(&mut self, prompt: Option<&OsStr>) -> Result<OsString>;
 
@@ -229,7 +222,6 @@
     /// ```
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_get_data: mwg, _std)]
     ///
     #[doc = guide!(mwg: "mwg-expected-by-module-item.html#mwg-pam_get_data")]
@@ -282,8 +274,8 @@
     ///     match client.get_module_data::<u64>("TOKEN_ID") {
     ///         Some(&tid) => {
     ///             // This will execute and tid will be 0x0fa1afe10000beef.
-    ///         },
-    ///         None => { /* This will not execute. */ },
+    ///         }
+    ///         None => { /* This will not execute. */ }
     ///     }
     ///     Ok(())
     /// }
@@ -305,10 +297,10 @@
     ///         Some(value) => {
     ///             // This will match, because pam_module_a's data
     ///             // is completely unrelated to pam_module_b's data.
-    ///         },
+    ///         }
     ///         None => {
     ///             // This branch will execute.
-    ///         },
+    ///         }
     ///     }
     ///     // ...
     /// #    Ok(())
@@ -349,7 +341,6 @@
     /// we do not (yet) offer this.
     ///
     /// # References
-    ///
     #[doc = linklist!(pam_set_data: mwg, _std)]
     ///
     #[doc = guide!(mwg: "mwg-expected-by-module-item.html#mwg-pam_set_data")]