Merge pull request #2 from asynchandler/develop

fix xml documentation

Author: eventsourcer

AsyncHandler.Assembly/AsyncHandler.Assembly.csproj

@@ -3,6 +3,7 @@
   <PropertyGroup>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <GenerateDocumentationFile>True</GenerateDocumentationFile>
   </PropertyGroup>
 
 </Project>

AsyncHandler.Assembly/TDiscover.cs

@@ -1,8 +1,14 @@
 namespace AsyncHandler.Asse;
 
 using System.Reflection;
+/// <summary>
+/// Helper methods to find your type
+/// </summary>
 public static class TDiscover
 {
+    /// <summary>
+    /// Exclude assemblies to enhance performance
+    /// </summary>
     public static IEnumerable<string> ExcludedAssemblies => ["Microsoft", "System", "Swashbuckle"];
     /// <summary>
     /// Searches through the provided assembly.

AsyncHandler.Assembly/TypeExtensions.cs

@@ -1,14 +1,17 @@
 namespace AsyncHandler.Asse;
 
 using System.Reflection;
+/// <summary>
+/// Helper methods to find your type
+/// </summary>
 public static class TypeExtensions
 {
 
     /// <summary>
     /// Searches through the provided assembly.
     /// </summary>
     /// <param name="assembly">The assembly to search through.</param>
-    /// <typeparam name="T">The type to search for.</typeparam>
+    /// <param name="type">The type to search for.</param>
     /// <returns>A Type if one is found or null otherwise</returns>
     public static Type? FindByAsse(this Type type, Assembly assembly)
     {
@@ -20,7 +23,7 @@ public static class TypeExtensions
     /// caller results in significant performance gains compared to AppDomain.
     /// </summary>
     /// <param name="caller">Calling assembly i.e. Assembly.GetCallingAssembly().</param>
-    /// <typeparam name="T">The type to search for a match.</typeparam>
+    /// <param name="type">The type to search for.</param>
     /// <returns>A Type if one is found or null otherwise</returns>
     public static Type? FindByCallingAsse(this Type type, Assembly caller)
     {
@@ -42,8 +45,8 @@ public static class TypeExtensions
     /// type parameter.
     /// use this when you have multiple matches and use the type arugment for an exact match.
     /// </summary>
+    /// <param name="type">The type argument to search for.</param>
     /// <param name="typeName">The type argument to search for.</param>
-    /// <typeparam name="T">The type parameter to search for a match.</typeparam>
     /// <returns>A Type if there is a match or null otherwise</returns>
     public static Type? FindByTypeName(this Type type, string typeName)
     {

Directory.Build.props

@@ -4,7 +4,7 @@
     <TargetFramework>net8.0</TargetFramework>
     <!-- <LangVersion>13</LangVersion> -->
     <!-- <GeneratePackageOnBuild>true</GeneratePackageOnBuild> -->
-    <Version>1.0.1</Version>
+    <Version>1.0.2</Version>
     <Authors>asynchandler</Authors>
     <Company>asynchandler</Company>
     <PackageTags>Assembly;Type;Reflection;Extensions;AppDomain;EventSourcing</PackageTags>

README.md

@@ -1,5 +1,5 @@
 # AsyncHandler.Assembly
-### .Net type discovery and assembly scanning made simplified.
+### A .Net library that helps making type discovery faster and simplified. 
 
 [![Github follow](https://img.shields.io/badge/follow-asynchandler-bf9136?logo=github)](https://github.com/asynchandler)
 [![Github follow](https://img.shields.io/badge/follow-eventsourcer-bf9136?logo=github)](https://github.com/eventsourcer)
@@ -12,7 +12,7 @@
 </div>
 
 ### Overview
-`AsyncHandler.Assembly` helps simplifying type discovery overhead when searching through .Net assemblies with a bunch of helpful methods to speed up your development.
+`AsyncHandler.Assembly` simplifies type discovery overhead when searching through .Net assemblies with a bunch of helpful methods to speed up your development.
 
 ### Prerequisities
 [![My Skills](https://skillicons.dev/icons?i=dotnet)](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)