Documentation

unitycontainer · Mar 24, 2019 · b362b06 · b362b06
1 parent 3330803
commit b362b06
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/src/Lifetime/Abstracts/IFactoryLifetimeManager.cs b/src/Lifetime/Abstracts/IFactoryLifetimeManager.cs
@@ -1,5 +1,13 @@
 namespace Unity.Lifetime
 {
+    /// <summary>
+    /// This interface marks all lifetime managers compatible with 
+    /// <see cref="IUnityContainer.RegisterFactory" /> registration.
+    /// </summary>
+    /// <remarks>
+    /// This interface is used for design type validation of registration compatibility.
+    /// Each registration type only takes lifetime managers compatible with it. 
+    /// </remarks>
     public interface IFactoryLifetimeManager
     {
     }

diff --git a/src/Lifetime/Abstracts/IInstanceLifetimeManager.cs b/src/Lifetime/Abstracts/IInstanceLifetimeManager.cs
@@ -1,5 +1,13 @@
 namespace Unity.Lifetime
 {
+    /// <summary>
+    /// This interface marks all lifetime managers compatible with 
+    /// <see cref="IUnityContainer.RegisterInstance" /> registration.
+    /// </summary>
+    /// <remarks>
+    /// This interface is used for design type validation of registration compatibility.
+    /// Each registration type only takes lifetime managers compatible with it. 
+    /// </remarks>
     public interface IInstanceLifetimeManager
     {
     }

diff --git a/src/Lifetime/Abstracts/ITypeLifetimeManager.cs b/src/Lifetime/Abstracts/ITypeLifetimeManager.cs
@@ -1,5 +1,13 @@
 namespace Unity.Lifetime
 {
+    /// <summary>
+    /// This interface marks all lifetime managers compatible with 
+    /// <see cref="IUnityContainer.RegisterType" /> registration.
+    /// </summary>
+    /// <remarks>
+    /// This interface is used for design type validation of registration compatibility.
+    /// Each registration type only takes lifetime managers compatible with it. 
+    /// </remarks>
     public interface ITypeLifetimeManager
     {
     }

diff --git a/src/Lifetime/Abstracts/LifetimeManager.cs b/src/Lifetime/Abstracts/LifetimeManager.cs
@@ -57,7 +57,7 @@ public virtual void RemoveValue(ILifetimeContainer container = null) { }
         /// Type of current lifetime manager
         /// </summary>
         /// <returns>The <see cref="Type"/> of the manager.</returns>
-        [Obsolete]
+        [Obsolete("This property will be removed in next major release. Use GetType() instead", false)]
         public Type LifetimeType => GetType();
 
         #endregion