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/di_container.rs | 91 +++++++++++++++++++++++++++--------------------------
 1 file changed, 46 insertions(+), 45 deletions(-)

(limited to 'src/di_container.rs')

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>
-- 
cgit v1.2.3-18-g5258