From b8ad113a840f107e58eabef9dded99f44748dfa5 Mon Sep 17 00:00:00 2001
From: Peter Limkilde Svendsen <peter.limkilde@gmail.com>
Date: Sun, 17 Nov 2024 16:12:43 +0000
Subject: [PATCH] Add docs for crypt.h

---
 src/header/crypt/mod.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/header/crypt/mod.rs b/src/header/crypt/mod.rs
index f12ba53b01..32fe2359b7 100644
--- a/src/header/crypt/mod.rs
+++ b/src/header/crypt/mod.rs
@@ -1,3 +1,7 @@
+//! `crypt.h` implementation.
+//!
+//! Non-POSIX, see <https://www.man7.org/linux/man-pages/man3/crypt.3.html>.
+
 // TODO: set this for entire crate when possible
 #![deny(unsafe_op_in_unsafe_fn)]
 
@@ -29,6 +33,7 @@ use self::{
     sha::{crypt_sha, ShaType::*},
 };
 
+/// See <https://www.man7.org/linux/man-pages/man3/crypt.3.html>.
 #[repr(C)]
 pub struct crypt_data {
     initialized: c_int,
@@ -51,6 +56,7 @@ fn gen_salt() -> Option<String> {
     Some(SaltString::encode_b64(&bytes).ok()?.as_str().to_string())
 }
 
+/// See <https://www.man7.org/linux/man-pages/man3/crypt.3.html>.
 #[no_mangle]
 pub unsafe extern "C" fn crypt_r(
     key: *const c_char,