docs: add doc comments & deny missing docs

10 files changed, 79 insertions, 45 deletions

diff --git a/src/di_container.rs b/src/di_container.rs
index e18fc3a..89bbcd1 100644
--- a/src/di_container.rs
+++ b/src/di_container.rs
@@ -1,3 +1,48 @@
+//! Dependency injection container and other related utilities.
+///
+/// # Examples
+/// ```
+/// use std::collections::HashMap;
+///
+/// use syrette::{DIContainer, injectable};
+/// use syrette::errors::di_container::DIContainerError;
+///
+/// trait IDatabaseService
+/// {
+///     fn get_all_records(&self, table_name: String) -> HashMap<String, String>;
+/// }
+///
+/// struct DatabaseService {}
+///
+/// #[injectable(IDatabaseService)]
+/// impl DatabaseService
+/// {
+///     fn new() -> Self
+///     {
+///         Self {}
+///     }
+/// }
+///
+/// impl IDatabaseService for DatabaseService
+/// {
+///     fn get_all_records(&self, table_name: String) -> HashMap<String, String>
+///     {
+///         // Do stuff here
+///         HashMap::<String, String>::new()
+///     }
+/// }
+///
+/// fn main() -> error_stack::Result<(), DIContainerError>
+/// {
+///     let mut di_container = DIContainer::new();
+///
+///     di_container.bind::<dyn IDatabaseService>().to::<DatabaseService>();
+///
+///     let database_service = di_container.get::<dyn IDatabaseService>()?;
+///
+///     Ok(())
+/// }
+/// ```
 use std::any::type_name;
 use std::marker::PhantomData;
 
@@ -101,50 +146,6 @@ where
 }
 
 /// Dependency injection container.
-///
-/// # Examples
-/// ```
-/// use std::collections::HashMap;
-///
-/// use syrette::{DIContainer, injectable};
-/// use syrette::errors::di_container::DIContainerError;
-///
-/// trait IDatabaseService
-/// {
-///     fn get_all_records(&self, table_name: String) -> HashMap<String, String>;
-/// }
-///
-/// struct DatabaseService {}
-///
-/// #[injectable(IDatabaseService)]
-/// impl DatabaseService
-/// {
-///     fn new() -> Self
-///     {
-///         Self {}
-///     }
-/// }
-///
-/// impl IDatabaseService for DatabaseService
-/// {
-///     fn get_all_records(&self, table_name: String) -> HashMap<String, String>
-///     {
-///         // Do stuff here
-///         HashMap::<String, String>::new()
-///     }
-/// }
-///
-/// fn main() -> error_stack::Result<(), DIContainerError>
-/// {
-///     let mut di_container = DIContainer::new();
-///
-///     di_container.bind::<dyn IDatabaseService>().to::<DatabaseService>();
-///
-///     let database_service = di_container.get::<dyn IDatabaseService>()?;
-///
-///     Ok(())
-/// }
-/// ```
 pub struct DIContainer
 {
     bindings: DIContainerBindingMap,
@@ -176,7 +177,7 @@ impl DIContainer
     /// - No binding for `Interface` exists
     /// - Resolving the binding for `Interface` fails
     /// - Casting the binding for `Interface` fails
-    /// - The binding for `Interface` is not injectable
+    /// - The binding for `Interface` is not transient
     pub fn get<Interface>(
         &self,
     ) -> error_stack::Result<TransientPtr<Interface>, DIContainerError>
diff --git a/src/errors/di_container.rs b/src/errors/di_container.rs
index 3b8c717..127676f 100644
--- a/src/errors/di_container.rs
+++ b/src/errors/di_container.rs
@@ -1,8 +1,11 @@
+//! Error types for the DI container.
+
 use std::fmt;
 use std::fmt::{Display, Formatter};
 
 use error_stack::Context;
 
+/// Error for when the DI container fails to do something.
 #[derive(Debug)]
 pub struct DIContainerError;
 
@@ -16,6 +19,7 @@ impl Display for DIContainerError
 
 impl Context for DIContainerError {}
 
+/// Error for when the binding builder fails to do something.
 #[derive(Debug)]
 pub struct BindingBuilderError;
 
diff --git a/src/errors/injectable.rs b/src/errors/injectable.rs
index 6b0cdc5..63afa11 100644
--- a/src/errors/injectable.rs
+++ b/src/errors/injectable.rs
@@ -1,8 +1,11 @@
+//! Error types for structs implementing Injectable.
+
 use core::fmt;
 use std::fmt::{Display, Formatter};
 
 use error_stack::Context;
 
+/// Error for when a injectable struct fails to be resolved.
 #[derive(Debug)]
 pub struct ResolveError;
 
diff --git a/src/errors/mod.rs b/src/errors/mod.rs
index b0d50f0..5f628d6 100644
--- a/src/errors/mod.rs
+++ b/src/errors/mod.rs
@@ -1,2 +1,4 @@
+//! Error types for various components of the library.
+
 pub mod di_container;
 pub mod injectable;
diff --git a/src/interfaces/any_factory.rs b/src/interfaces/any_factory.rs
index 41063e1..98ec144 100644
--- a/src/interfaces/any_factory.rs
+++ b/src/interfaces/any_factory.rs
@@ -1,3 +1,6 @@
+//! Interface for any factory to ever exist.
+
 use crate::libs::intertrait::CastFrom;
 
+/// Interface for any factory to ever exist.
 pub trait AnyFactory: CastFrom {}
diff --git a/src/interfaces/factory.rs b/src/interfaces/factory.rs
index 6f8e7c7..d3d55da 100644
--- a/src/interfaces/factory.rs
+++ b/src/interfaces/factory.rs
@@ -1,7 +1,18 @@
 #![allow(clippy::module_name_repetitions)]
+
+//! Interface for a factory.
+
 use crate::libs::intertrait::CastFrom;
 use crate::ptr::TransientPtr;
 
+/// Interface for a factory.
+///
+/// # Examples
+/// ```
+/// use syrette::interface::factory::IFactory;
+///
+/// type StringFactory = dyn IFactory<(), String>;
+/// ```
 pub trait IFactory<Args, ReturnInterface>:
     Fn<Args, Output = TransientPtr<ReturnInterface>> + CastFrom
 where
diff --git a/src/interfaces/injectable.rs b/src/interfaces/injectable.rs
index 0af1217..31cd21b 100644
--- a/src/interfaces/injectable.rs
+++ b/src/interfaces/injectable.rs
@@ -1,8 +1,10 @@
+//! Interface for structs that can be injected into or be injected to.
 use crate::errors::injectable::ResolveError;
 use crate::libs::intertrait::CastFrom;
 use crate::ptr::TransientPtr;
 use crate::DIContainer;
 
+/// Interface for structs that can be injected into or be injected to.
 pub trait Injectable: CastFrom
 {
     /// Resolves the dependencies of the injectable.
diff --git a/src/interfaces/mod.rs b/src/interfaces/mod.rs
index 497521e..eef7190 100644
--- a/src/interfaces/mod.rs
+++ b/src/interfaces/mod.rs
@@ -1,3 +1,5 @@
+//! Various useful interfaces.
+
 pub mod any_factory;
 pub mod injectable;
 
diff --git a/src/lib.rs b/src/lib.rs
index d7314ad..4d1ce78 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,6 +1,7 @@
 #![cfg_attr(feature = "factory", feature(unboxed_closures, fn_traits))]
 #![deny(clippy::all)]
 #![deny(clippy::pedantic)]
+#![deny(missing_docs)]
 
 //! Syrette
 //!
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>;