add docs

Author: BenjaminAbt

src/MyCSharp.HttpUserAgentParser/DependencyInjection/HttpUserAgentParserDependencyInjectionOptions.cs

@@ -1,16 +1,26 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 using Microsoft.Extensions.DependencyInjection;
 
 namespace MyCSharp.HttpUserAgentParser.DependencyInjection
 {
+    /// <summary>
+    /// Options for dependency injection
+    /// </summary>
     public class HttpUserAgentParserDependencyInjectionOptions
     {
+        /// <summary>
+        /// Services container
+        /// </summary>
         public IServiceCollection Services { get; }
 
+        /// <summary>
+        /// Creates a new instance of <see cref="HttpUserAgentParserDependencyInjectionOptions"/>
+        /// </summary>
+        /// <param name="services"></param>
         public HttpUserAgentParserDependencyInjectionOptions(IServiceCollection services)
         {
             Services = services;
         }
     }
-}
+}

src/MyCSharp.HttpUserAgentParser/DependencyInjection/HttpUserAgentParserServiceCollectionExtensions.cs

@@ -1,10 +1,13 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 using Microsoft.Extensions.DependencyInjection;
 using MyCSharp.HttpUserAgentParser.Providers;
 
 namespace MyCSharp.HttpUserAgentParser.DependencyInjection
 {
+    /// <summary>
+    /// Dependency injection extensions
+    /// </summary>
     public static class HttpUserAgentParserServiceCollectionExtensions
     {
         /// <summary>

src/MyCSharp.HttpUserAgentParser/Providers/HttpUserAgentParserCachedProvider.cs

@@ -4,14 +4,30 @@
 
 namespace MyCSharp.HttpUserAgentParser.Providers
 {
+    /// <summary>
+    /// In process cache provider for <see cref="IHttpUserAgentParserProvider"/>
+    /// </summary>
     public class HttpUserAgentParserCachedProvider : IHttpUserAgentParserProvider
     {
+        /// <summary>
+        /// internal cache
+        /// </summary>
         private readonly ConcurrentDictionary<string, HttpUserAgentInformation> _cache = new();
 
+        /// <summary>
+        /// Parses the user agent or uses the internal cached information
+        /// </summary>
         public HttpUserAgentInformation Parse(string userAgent)
             => _cache.GetOrAdd(userAgent, static ua => HttpUserAgentParser.Parse(ua));
 
+        /// <summary>
+        /// Total count of entries in cache
+        /// </summary>
         public int CacheEntryCount => _cache.Count;
+
+        /// <summary>
+        /// returns true if given user agent is in cache
+        /// </summary>
         public bool HasCacheEntry(string userAgent) => _cache.ContainsKey(userAgent);
     }
 }

src/MyCSharp.HttpUserAgentParser/Providers/HttpUserAgentParserDefaultProvider.cs

@@ -1,10 +1,16 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 namespace MyCSharp.HttpUserAgentParser.Providers
 {
+    /// <summary>
+    /// Simple parse provider
+    /// </summary>
     public class HttpUserAgentParserDefaultProvider : IHttpUserAgentParserProvider
     {
+        /// <summary>
+        /// returns the result of <see cref="HttpUserAgentParser.Parse"/>
+        /// </summary>
         public HttpUserAgentInformation Parse(string userAgent)
             => HttpUserAgentParser.Parse(userAgent);
     }
-}
+}