From 10b6575f982ea229663097bfa950a778f6809099 Mon Sep 17 00:00:00 2001
From: Botahamec <botahamec@outlook.com>
Date: Thu, 27 Oct 2022 18:45:49 -0400
Subject: Documentation for `Key`

---
 src/lock.rs | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src')

diff --git a/src/lock.rs b/src/lock.rs
index 5a6315d..54a836d 100644
--- a/src/lock.rs
+++ b/src/lock.rs
@@ -6,12 +6,17 @@ pub struct Lock {
 	is_locked: AtomicBool,
 }
 
+/// A key for a lock.
+///
+/// This key is needed in order to unlock a [`Lock`]. The [`Lock`] is
+/// automatically unlocked if this key is dropped.
 #[derive(Debug)]
 pub struct Key<'a> {
 	lock: &'a Lock,
 }
 
 impl<'a> Key<'a> {
+	/// Create a key to a lock.
 	const fn new(lock: &'a Lock) -> Self {
 		Self { lock }
 	}
-- 
cgit v1.2.3