Add code documentation to all types and methods (excluded tests)

Author: ManticSic

src/UnityContainerAttributeRegistration/Adapter/AppDomainAdapter.cs

@@ -5,8 +5,10 @@
 
 namespace UnityContainerAttributeRegistration.Adapter
 {
+    /// <inheritdoc cref="IAppDomainAdapter"/>
     internal class AppDomainAdapter : IAppDomainAdapter
     {
+        /// <inheritdoc cref="IAppDomainAdapter.GetAssemblies"/>
         public IList<Assembly> GetAssemblies()
         {
             return AppDomain.CurrentDomain.GetAssemblies();

src/UnityContainerAttributeRegistration/Adapter/IAppDomainAdapter.cs

@@ -5,14 +5,14 @@
 namespace UnityContainerAttributeRegistration.Adapter
 {
     /// <summary>
-    /// Wrapper to provide <see cref="IList{Assembly}"/> instead of using <see cref="System.AppDomain"/>
+    /// Wrapper to provide <see cref="IList{Assembly}"/> instead of using <see cref="System.AppDomain"/>.
     /// </summary>
     public interface IAppDomainAdapter
     {
         /// <summary>
-        /// Provice <see cref="Assembly"/>s of an AppDomain
+        /// Provide <see cref="Assembly"/>s of an AppDomain.
         /// </summary>
-        /// <returns><see cref="Assembly"/>s which are used to populate </returns>
+        /// <returns><see cref="Assembly"/>s which are used to populate.</returns>
         public IList<Assembly> GetAssemblies();
     }
 }

src/UnityContainerAttributeRegistration/Attribute/RegisterTypeAttribute.cs

@@ -11,6 +11,9 @@ namespace UnityContainerAttributeRegistration.Attribute
     [AttributeUsage(AttributeTargets.Class)]
     public class RegisterTypeAttribute : System.Attribute
     {
+        /// <summary>
+        /// Candidate class for registration to <see cref="Unity"/>.
+        /// </summary>
         /// <param name="from"><see cref="Type"/> that will be requested.</param>
         /// <param name="lifetimeManager">The <see cref="Unity.Lifetime.ITypeLifetimeManager"/> that controls the lifetime of the returned instance.</param>
         public RegisterTypeAttribute([CanBeNull] Type from            = null,
@@ -20,9 +23,16 @@ public RegisterTypeAttribute([CanBeNull] Type from            = null,
             LifetimeManager = lifetimeManager;
         }
 
+        /// <summary>
+        /// <see cref="Type"/> that will be requested.
+        /// </summary>
         [CanBeNull]
         internal Type From { get; }
 
+        /// <summary>
+        /// The <see cref="LifetimeManager"/> that controls the lifetime
+        /// of the returned instance.
+        /// </summary>
         [CanBeNull]
         internal Type LifetimeManager { get; }
     }

src/UnityContainerAttributeRegistration/Exention/TypeExtension.cs

@@ -3,8 +3,16 @@
 
 namespace UnityContainerAttributeRegistration.Exention
 {
+    /// <summary>
+    /// Extensions for <see cref="Type"/>.
+    /// </summary>
     internal static class TypeExtension
     {
+        /// <summary>
+        /// Checks if a type is static.
+        /// </summary>
+        /// <param name="self"><see cref="Type"/> to be checked.</param>
+        /// <returns>whether a type is static or not.</returns>
         public static bool IsStatic(this Type self)
         {
             return self.IsAbstract && self.IsSealed;

src/UnityContainerAttributeRegistration/Populator/IPopulator.cs

@@ -3,8 +3,16 @@
 
 namespace UnityContainerAttributeRegistration.Populator
 {
-    public interface IPopulator
+    /// <summary>
+    /// Interface for internal populators.
+    /// </summary>
+    internal interface IPopulator
     {
+        /// <summary>
+        /// Populate the passed <paramref name="container"/>.
+        /// </summary>
+        /// <param name="container"><see cref="IUnityContainer"/> to populate.</param>
+        /// <returns>Passed <paramref name="container"/>.</returns>
         public IUnityContainer Populate(IUnityContainer container);
     }
 }

src/UnityContainerAttributeRegistration/Populator/Populator.cs

@@ -9,17 +9,31 @@
 
 namespace UnityContainerAttributeRegistration.Populator
 {
+    /// <summary>
+    /// <see cref="IPopulator"/> providing some basic functionality for reflection.
+    /// </summary>
     internal abstract class Populator : IPopulator
     {
         private readonly IAppDomainAdapter appDomain;
 
-        public Populator(IAppDomainAdapter appDomain)
+        /// <summary>
+        /// ctor
+        /// </summary>
+        /// <param name="appDomain">Used <see cref="IAppDomainAdapter"/> for searching for candidates.</param>
+        protected Populator(IAppDomainAdapter appDomain)
         {
             this.appDomain = appDomain;
         }
 
+        /// <inheritdoc cref="IPopulator.Populate"/>
         public abstract IUnityContainer Populate(IUnityContainer container);
 
+        /// <summary>
+        /// Find all types using <typeparamref name="TAttribute"/>.
+        /// </summary>
+        /// <param name="typeDefined">Using inheritance or not.</param>
+        /// <typeparam name="TAttribute"><see cref="System.Attribute"/> used by searched <see cref="Type"/>s.</typeparam>
+        /// <returns>List of all <see cref="Type"/>s in an <see cref="IAppDomainAdapter"/> using <typeparamref name="TAttribute"/>.</returns>
         protected IEnumerable<Type> GetTypesWith<TAttribute>(TypeDefined typeDefined) where TAttribute : System.Attribute
         {
             return appDomain.GetAssemblies()

src/UnityContainerAttributeRegistration/Populator/TypePopulator.cs

@@ -15,13 +15,27 @@
 
 namespace UnityContainerAttributeRegistration.Populator
 {
+    /// <summary>
+    /// Populator for the <see cref="UnityContainerAttributeRegistration.Attribute.RegisterTypeAttribute"/>.
+    /// </summary>
     internal class TypePopulator : Populator
     {
-
+        /// <summary>
+        /// ctor
+        /// </summary>
+        /// <param name="appDomain">
+        /// Used <see cref="IAppDomainAdapter"/> to find all candidates using <see cref="RegisterTypeAttribute"/>
+        /// </param>
         public TypePopulator(IAppDomainAdapter appDomain) : base(appDomain)
         {
         }
 
+        /// <summary>
+        /// Populate the passed <paramref name="container"/>.
+        /// </summary>
+        /// <param name="container"><see cref="IUnityContainer"/> to populate.</param>
+        /// <returns>Passed <paramref name="container"/>.</returns>
+        /// <exception cref="InvalidOperationException">Class type must not be static or abstract.</exception>
         public override IUnityContainer Populate(IUnityContainer container)
         {
             IList<Type> typesWithAttribute = GetTypesWith<RegisterTypeAttribute>(TypeDefined.Inherit)
@@ -31,7 +45,7 @@ public override IUnityContainer Populate(IUnityContainer container)
             {
                 if(to.IsStatic() || to.IsAbstract)
                 {
-                    throw new InvalidOperationException($"Type must not be static or abstract to be used with RegisterTypeAttribute: {to.FullName}");
+                    throw new InvalidOperationException($"Class type must not be static or abstract to be used with RegisterTypeAttribute: {to.FullName}");
                 }
 
                 RegisterTypeAttribute attribute = to.GetCustomAttribute<RegisterTypeAttribute>();
@@ -45,6 +59,13 @@ public override IUnityContainer Populate(IUnityContainer container)
             return container;
         }
 
+        /// <summary>
+        /// Create an instance for <paramref name="objectType"/>.
+        /// </summary>
+        /// <param name="objectType"><see cref="Type"/> used to create an instance.</param>
+        /// <typeparam name="T"><paramref name="objectType"/> must be type-equal to, inherit or implement <typeparamref name="T"/>.</typeparam>
+        /// <returns>New instance of <paramref name="objectType"/> as <typeparamref name="T"/>.</returns>
+        /// <exception cref="InvalidOperationException">Cannot create an instance of <paramref name="objectType" />. Whether <paramref name="objectType"/> is not type-equal, does not inherit or implement <typeparamref name="T"/> or has no default constructor.</exception>
         [NotNull]
         private T GetInstanceByType<T>([NotNull] Type objectType)
         {

src/UnityContainerAttributeRegistration/TypeDefined.cs

@@ -1,8 +1,17 @@
 namespace UnityContainerAttributeRegistration
 {
+    /// <summary>
+    /// Enum to avoid booleans.
+    /// </summary>
     internal enum TypeDefined
     {
+        /// <summary>
+        /// Include inheritance.
+        /// </summary>
         Inherit,
+        /// <summary>
+        /// Not include inheritance.
+        /// </summary>
         NotInherit
     }
 }

src/UnityContainerAttributeRegistration/UnityContainerAttributeRegistration.csproj

@@ -19,17 +19,18 @@
         <RepositoryUrl>https://github.com/ManticSic/UnityContainerAttributeRegistration</RepositoryUrl>
         <RepositoryType>git</RepositoryType>
     </PropertyGroup>
+    
+    <PropertyGroup>
+        <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+        <WarningsAsErrors />
+        <NoWarn />
+        <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
+    </PropertyGroup>
 
     <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
-      <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-      <WarningsAsErrors />
-      <NoWarn />
     </PropertyGroup>
 
     <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
-      <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-      <WarningsAsErrors />
-      <NoWarn />
     </PropertyGroup>
 
     <ItemGroup>