aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2023-08-17 22:31:22 +0200
committerHampusM <hampus@hampusmat.com>2023-08-17 22:31:22 +0200
commitdd3c988d8734f5ff6b2f0a528224ca26db1b402b (patch)
treeedd94dc2203f90e68a9329beb0501e7eda340d82 /src
parent9626e73647db157011140aa85b6249cf7c9f1ac2 (diff)
docs: add existance reason to DependencyHistory docs
Diffstat (limited to 'src')
-rw-r--r--src/dependency_history.rs8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/dependency_history.rs b/src/dependency_history.rs
index cd4e77d..81d5434 100644
--- a/src/dependency_history.rs
+++ b/src/dependency_history.rs
@@ -8,6 +8,14 @@ const BOLD_MODE: &str = "\x1b[1m";
const RESET_BOLD_MODE: &str = "\x1b[22m";
/// Dependency history.
+///
+/// Used by the implementations of [`Injectable`] and [`AsyncInjectable`] generated by
+/// the [`injectable`] macro to prevent circular dependencies when the `prevent-circular`
+/// crate feature is enabled.
+///
+/// [`Injectable`]: crate::interfaces::injectable::Injectable
+/// [`AsyncInjectable`]: crate::interfaces::async_injectable::AsyncInjectable
+/// [`injectable`]: crate::injectable
#[derive(Clone, Debug)]
pub struct DependencyHistory
{