Merge pull request #14 from mycsharp/feature/summary

add summaries

Author: BenjaminAbt

src/MyCSharp.HttpUserAgentParser.AspNetCore/DependencyInjection/HttpUserAgentParserDependencyInjectionOptionsExtensions.cs

@@ -1,11 +1,14 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 using Microsoft.Extensions.DependencyInjection;
 using MyCSharp.HttpUserAgentParser.DependencyInjection;
 using MyCSharp.HttpUserAgentParser.Providers;
 
 namespace MyCSharp.HttpUserAgentParser.AspNetCore.DependencyInjection
 {
+    /// <summary>
+    /// Dependency injection extensions for ASP.NET Core environments
+    /// </summary>
     public static class HttpUserAgentParserDependencyInjectionOptionsExtensions
     {
         /// <summary>
@@ -19,4 +22,4 @@ public static HttpUserAgentParserDependencyInjectionOptions AddHttpUserAgentPars
             return options;
         }
     }
-}
+}

src/MyCSharp.HttpUserAgentParser.AspNetCore/HttpUserAgentParserAccessor.cs

@@ -5,26 +5,48 @@
 
 namespace MyCSharp.HttpUserAgentParser.AspNetCore
 {
+    /// <summary>
+    /// User Agent parser accessor
+    /// </summary>
     public interface IHttpUserAgentParserAccessor
     {
+        /// <summary>
+        /// User agent value
+        /// </summary>
         string HttpContextUserAgent { get; }
+
+        /// <summary>
+        /// Returns current <see cref="HttpUserAgentInformation"/>
+        /// </summary>
         HttpUserAgentInformation Get();
     }
 
+    /// <summary>
+    /// User Agent parser accessor. Implements <see cref="IHttpContextAccessor.HttpContext"/>
+    /// </summary>
     public class HttpUserAgentParserAccessor : IHttpUserAgentParserAccessor
     {
         private readonly IHttpContextAccessor _httpContextAccessor;
         private readonly IHttpUserAgentParserProvider _httpUserAgentParser;
 
+        /// <summary>
+        /// Creates a new instance of <see cref="HttpUserAgentParserAccessor"/>
+        /// </summary>
         public HttpUserAgentParserAccessor(IHttpContextAccessor httpContextAccessor, IHttpUserAgentParserProvider httpUserAgentParser)
         {
             _httpContextAccessor = httpContextAccessor;
             _httpUserAgentParser = httpUserAgentParser;
         }
 
+        /// <summary>
+        /// User agent of current <see cref="IHttpContextAccessor"/>
+        /// </summary>
         public string HttpContextUserAgent =>
             _httpContextAccessor.HttpContext?.Request?.Headers["User-Agent"].ToString()!;
 
+        /// <summary>
+        /// Returns current <see cref="HttpUserAgentInformation"/> of current <see cref="IHttpContextAccessor"/>
+        /// </summary>
         public HttpUserAgentInformation Get()
             => _httpUserAgentParser.Parse(this.HttpContextUserAgent);
     }

src/MyCSharp.HttpUserAgentParser.MemoryCache/DependencyInjection/HttpUserAgentParserMemoryCacheServiceCollectionExtensions.cs

@@ -1,4 +1,4 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 using System;
 using Microsoft.Extensions.DependencyInjection;
@@ -7,6 +7,9 @@
 
 namespace MyCSharp.HttpUserAgentParser.MemoryCache.DependencyInjection
 {
+    /// <summary>
+    /// Dependency injection extensions for IMemoryCache
+    /// </summary>
     public static class HttpUserAgentParserMemoryCacheServiceCollectionExtensions
     {
         /// <summary>

src/MyCSharp.HttpUserAgentParser.MemoryCache/HttpUserAgentParserMemoryCachedProviderOptions.cs

@@ -14,15 +14,31 @@ namespace MyCSharp.HttpUserAgentParser.MemoryCache
     /// </summary>
     public class HttpUserAgentParserMemoryCachedProviderOptions
     {
+        /// <summary>
+        /// Cache options
+        /// </summary>
         public MemoryCacheOptions CacheOptions { get; }
+
+        /// <summary>
+        /// Cache entry options
+        /// </summary>
         public MemoryCacheEntryOptions CacheEntryOptions { get; }
 
+        /// <summary>
+        /// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
+        /// </summary>
         public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheOptions cacheOptions)
             : this(cacheOptions, null) { }
 
+        /// <summary>
+        /// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
+        /// </summary>
         public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheEntryOptions cacheEntryOptions)
             : this(null, cacheEntryOptions) { }
 
+        /// <summary>
+        /// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
+        /// </summary>
         public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheOptions? cacheOptions = null, MemoryCacheEntryOptions? cacheEntryOptions = null)
         {
             this.CacheEntryOptions = cacheEntryOptions ?? new MemoryCacheEntryOptions

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/HttpUserAgentInformation.cs

@@ -2,16 +2,46 @@
 
 namespace MyCSharp.HttpUserAgentParser
 {
+    /// <summary>
+    /// Analyzed user agent
+    /// </summary>
     public readonly struct HttpUserAgentInformation
     {
+        /// <summary>
+        /// Full User Agent string
+        /// </summary>
         public string UserAgent { get; }
+
+        /// <summary>
+        /// Type of user agent, see <see cref="HttpUserAgentType"/>
+        /// </summary>
         public HttpUserAgentType Type { get; }
 
+        /// <summary>
+        /// Platform of user agent, see <see cref="HttpUserAgentPlatformInformation"/>
+        /// </summary>
         public HttpUserAgentPlatformInformation? Platform { get; }
+
+        /// <summary>
+        /// Browser or Bot Name of user agent e.g. "Chrome", "Edge"..
+        /// </summary>
         public string? Name { get; }
+
+
+        /// <summary>
+        /// Version of Browser or Bot Name of user agent e.g. "79.0", "83.0.125.4"
+        /// </summary>
         public string? Version { get; }
+
+
+        /// <summary>
+        /// Device Type of user agent, e.g. "Android", "Apple iPhone"
+        /// </summary>
         public string? MobileDeviceType { get; }
 
+        /// <summary>
+        /// Creates a new instance of <see cref="HttpUserAgentInformation"/>
+        /// </summary>
         private HttpUserAgentInformation(string userAgent, HttpUserAgentPlatformInformation? platform, HttpUserAgentType type, string? name, string? version, string? deviceName)
         {
             UserAgent = userAgent;
@@ -22,19 +52,27 @@ private HttpUserAgentInformation(string userAgent, HttpUserAgentPlatformInformat
             MobileDeviceType = deviceName;
         }
 
-        // parse
-
+        /// <summary>
+        /// Parses given <param name="userAgent">User Agent</param>
+        /// </summary>
         public static HttpUserAgentInformation Parse(string userAgent) => HttpUserAgentParser.Parse(userAgent);
 
-        // create factories
-
-        public static HttpUserAgentInformation CreateForRobot(string userAgent, string robotName)
+        /// <summary>
+        /// Creates <see cref="HttpUserAgentInformation"/> for a robot
+        /// </summary>
+        internal static HttpUserAgentInformation CreateForRobot(string userAgent, string robotName)
             => new(userAgent, null, HttpUserAgentType.Robot, robotName, null, null);
 
-        public static HttpUserAgentInformation CreateForBrowser(string userAgent, HttpUserAgentPlatformInformation? platform, string? browserName, string? browserVersion, string? deviceName)
+        /// <summary>
+        /// Creates <see cref="HttpUserAgentInformation"/> for a browser
+        /// </summary>
+        internal static HttpUserAgentInformation CreateForBrowser(string userAgent, HttpUserAgentPlatformInformation? platform, string? browserName, string? browserVersion, string? deviceName)
             => new(userAgent, platform, HttpUserAgentType.Browser, browserName, browserVersion, deviceName);
 
-        public static HttpUserAgentInformation CreateForUnknown(string userAgent, HttpUserAgentPlatformInformation? platform, string? deviceName)
+        /// <summary>
+        /// Creates <see cref="HttpUserAgentInformation"/> for an unknown agent type
+        /// </summary>
+        internal static HttpUserAgentInformation CreateForUnknown(string userAgent, HttpUserAgentPlatformInformation? platform, string? deviceName)
             => new(userAgent, platform, HttpUserAgentType.Unknown, null, null, deviceName);
     }
 }

src/MyCSharp.HttpUserAgentParser/HttpUserAgentInformationExtensions.cs

@@ -1,12 +1,31 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 namespace MyCSharp.HttpUserAgentParser
 {
+    /// <summary>
+    /// Extensions for <see cref="HttpUserAgentInformation"/>
+    /// </summary>
     public static class HttpUserAgentInformationExtensions
     {
+        /// <summary>
+        /// Tests if <paramref name="userAgent"/> is of <paramref name="type" />
+        /// </summary>
         public static bool IsType(this in HttpUserAgentInformation userAgent, HttpUserAgentType type) => userAgent.Type == type;
+
+        /// <summary>
+        /// Tests if <paramref name="userAgent"/> is of type <see cref="HttpUserAgentType.Robot"/>
+        /// </summary>
         public static bool IsRobot(this in HttpUserAgentInformation userAgent) => IsType(userAgent, HttpUserAgentType.Robot);
+
+        /// <summary>
+        /// Tests if <paramref name="userAgent"/> is of type <see cref="HttpUserAgentType.Browser"/>
+        /// </summary>
         public static bool IsBrowser(this in HttpUserAgentInformation userAgent) => IsType(userAgent, HttpUserAgentType.Browser);
+
+        /// <summary>
+        /// returns <c>true</c> if agent is a mobile device
+        /// </summary>
+        /// <remarks>checks if <see cref="HttpUserAgentInformation.MobileDeviceType"/> is null</remarks>
         public static bool IsMobile(this in HttpUserAgentInformation userAgent) => userAgent.MobileDeviceType is not null;
     }
 }

src/MyCSharp.HttpUserAgentParser/HttpUserAgentParser.cs

@@ -1,13 +1,19 @@
-// Copyright © myCSharp 2020-2021, all rights reserved
+// Copyright © myCSharp 2020-2021, all rights reserved
 
 using System;
 using System.Diagnostics.CodeAnalysis;
 using System.Text.RegularExpressions;
 
 namespace MyCSharp.HttpUserAgentParser
 {
+    /// <summary>
+    /// Parser logic for user agents
+    /// </summary>
     public static class HttpUserAgentParser
     {
+        /// <summary>
+        /// Parses given <param name="userAgent">user agent</param>
+        /// </summary>
         public static HttpUserAgentInformation Parse(string userAgent)
         {
             // prepare
@@ -30,8 +36,14 @@ public static HttpUserAgentInformation Parse(string userAgent)
             return HttpUserAgentInformation.CreateForUnknown(userAgent, platform, mobileDeviceType);
         }
 
+        /// <summary>
+        /// pre-cleanup of <param name="userAgent">user agent</param>
+        /// </summary>
         public static string Cleanup(string userAgent) => userAgent.Trim();
 
+        /// <summary>
+        /// returns the platform or null
+        /// </summary>
         public static HttpUserAgentPlatformInformation? GetPlatform(string userAgent)
         {
             foreach (HttpUserAgentPlatformInformation item in HttpUserAgentStatics.Platforms)
@@ -45,12 +57,18 @@ public static HttpUserAgentInformation Parse(string userAgent)
             return null;
         }
 
+        /// <summary>
+        /// returns true if platform was found
+        /// </summary>
         public static bool TryGetPlatform(string userAgent, [NotNullWhen(true)] out HttpUserAgentPlatformInformation? platform)
         {
             platform = GetPlatform(userAgent);
             return platform is not null;
         }
 
+        /// <summary>
+        /// returns the browser or null
+        /// </summary>
         public static (string Name, string? Version)? GetBrowser(string userAgent)
         {
             foreach ((Regex key, string? value) in HttpUserAgentStatics.Browsers)
@@ -65,12 +83,18 @@ public static (string Name, string? Version)? GetBrowser(string userAgent)
             return null;
         }
 
+        /// <summary>
+        /// returns true if browser was found
+        /// </summary>
         public static bool TryGetBrowser(string userAgent, [NotNullWhen(true)] out (string Name, string? Version)? browser)
         {
             browser = GetBrowser(userAgent);
             return browser is not null;
         }
 
+        /// <summary>
+        /// returns the robot or null
+        /// </summary>
         public static string? GetRobot(string userAgent)
         {
             foreach ((string key, string value) in HttpUserAgentStatics.Robots)
@@ -84,12 +108,18 @@ public static bool TryGetBrowser(string userAgent, [NotNullWhen(true)] out (stri
             return null;
         }
 
+        /// <summary>
+        /// returns true if robot was found
+        /// </summary>
         public static bool TryGetRobot(string userAgent, [NotNullWhen(true)] out string? robotName)
         {
             robotName = GetRobot(userAgent);
             return robotName is not null;
         }
 
+        /// <summary>
+        /// returns the device or null
+        /// </summary>
         public static string? GetMobileDevice(string userAgent)
         {
             foreach ((string key, string value) in HttpUserAgentStatics.Mobiles)
@@ -103,6 +133,9 @@ public static bool TryGetRobot(string userAgent, [NotNullWhen(true)] out string?
             return null;
         }
 
+        /// <summary>
+        /// returns true if device was found
+        /// </summary>
         public static bool TryGetMobileDevice(string userAgent, [NotNullWhen(true)] out string? device)
         {
             device = GetMobileDevice(userAgent);