From 980bedd54ee4f0d0da3902fc22cfaebdfd3ff1b8 Mon Sep 17 00:00:00 2001 From: HampusM Date: Mon, 1 Aug 2022 18:14:12 +0200 Subject: docs: add factory feature notices --- macros/src/lib.rs | 2 ++ src/di_container.rs | 4 ++++ src/interfaces/factory.rs | 5 ++++- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/macros/src/lib.rs b/macros/src/lib.rs index 86db787..9b97be6 100644 --- a/macros/src/lib.rs +++ b/macros/src/lib.rs @@ -90,6 +90,8 @@ pub fn injectable(args_stream: TokenStream, impl_stream: TokenStream) -> TokenSt /// Makes a type alias usable as a factory interface. /// +/// *This macro is only available if Syrette is built with the "factory" feature.* +/// /// # Panics /// If the attributed item is not a type alias. /// diff --git a/src/di_container.rs b/src/di_container.rs index 89bbcd1..9509bd8 100644 --- a/src/di_container.rs +++ b/src/di_container.rs @@ -126,6 +126,8 @@ where /// Creates a binding of factory type `Interface` to a factory inside of the /// associated [`DIContainer`]. + /// + /// *This function is only available if Syrette is built with the "factory" feature.* #[cfg(feature = "factory")] pub fn to_factory( &mut self, @@ -228,6 +230,8 @@ impl DIContainer /// Returns the factory bound with factory type `Interface`. /// + /// *This function is only available if Syrette is built with the "factory" feature.* + /// /// # Errors /// Will return `Err` if: /// - No binding for `Interface` exists diff --git a/src/interfaces/factory.rs b/src/interfaces/factory.rs index d3d55da..29b9f08 100644 --- a/src/interfaces/factory.rs +++ b/src/interfaces/factory.rs @@ -1,7 +1,10 @@ #![allow(clippy::module_name_repetitions)] //! Interface for a factory. - +//! +//! --- +//! +//! *This module is only available if Syrette is built with the "factory" feature.* use crate::libs::intertrait::CastFrom; use crate::ptr::TransientPtr; -- cgit v1.2.3-18-g5258