From dd3c988d8734f5ff6b2f0a528224ca26db1b402b Mon Sep 17 00:00:00 2001 From: HampusM Date: Thu, 17 Aug 2023 22:31:22 +0200 Subject: docs: add existance reason to DependencyHistory docs --- src/dependency_history.rs | 8 ++++++++ 1 file changed, 8 insertions(+) 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 { -- cgit v1.2.3-18-g5258