From 7a6575220c6d9db564514bcbee552faa29095738 Mon Sep 17 00:00:00 2001
From: HampusM <hampus@hampusmat.com>
Date: Sun, 31 Jul 2022 17:27:33 +0200
Subject: docs: add doc comments & deny missing docs

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

(limited to 'src/ptr.rs')

diff --git a/src/ptr.rs b/src/ptr.rs
index 00c74f4..082edf2 100644
--- a/src/ptr.rs
+++ b/src/ptr.rs
@@ -1,8 +1,13 @@
 #![allow(clippy::module_name_repetitions)]
+
+//! Smart pointer type aliases.
 use std::rc::Rc;
 
+/// A smart pointer unique to the holder.
 pub type TransientPtr<Interface> = Box<Interface>;
 
+/// A smart pointer to a shared resource.
 pub type SingletonPtr<Interface> = Rc<Interface>;
 
+/// A smart pointer to a factory.
 pub type FactoryPtr<FactoryInterface> = Rc<FactoryInterface>;
-- 
cgit v1.2.3-18-g5258