Skip to content

Commit fb2732d

Browse files
committed
add docs
1 parent e43cc45 commit fb2732d

File tree

4 files changed

+47
-3
lines changed

4 files changed

+47
-3
lines changed

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
// Copyright © myCSharp 2020-2021, all rights reserved
1+
// Copyright © myCSharp 2020-2021, all rights reserved
22

33
using Microsoft.Extensions.DependencyInjection;
44
using MyCSharp.HttpUserAgentParser.DependencyInjection;
55
using MyCSharp.HttpUserAgentParser.Providers;
66

77
namespace MyCSharp.HttpUserAgentParser.AspNetCore.DependencyInjection
88
{
9+
/// <summary>
10+
/// Dependency injection extensions for ASP.NET Core environments
11+
/// </summary>
912
public static class HttpUserAgentParserDependencyInjectionOptionsExtensions
1013
{
1114
/// <summary>
@@ -19,4 +22,4 @@ public static HttpUserAgentParserDependencyInjectionOptions AddHttpUserAgentPars
1922
return options;
2023
}
2124
}
22-
}
25+
}

src/MyCSharp.HttpUserAgentParser.AspNetCore/HttpUserAgentParserAccessor.cs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,48 @@
55

66
namespace MyCSharp.HttpUserAgentParser.AspNetCore
77
{
8+
/// <summary>
9+
/// User Agent parser accessor
10+
/// </summary>
811
public interface IHttpUserAgentParserAccessor
912
{
13+
/// <summary>
14+
/// User agent value
15+
/// </summary>
1016
string HttpContextUserAgent { get; }
17+
18+
/// <summary>
19+
/// Returns current <see cref="HttpUserAgentInformation"/>
20+
/// </summary>
1121
HttpUserAgentInformation Get();
1222
}
1323

24+
/// <summary>
25+
/// User Agent parser accessor. Implements <see cref="IHttpContextAccessor.HttpContext"/>
26+
/// </summary>
1427
public class HttpUserAgentParserAccessor : IHttpUserAgentParserAccessor
1528
{
1629
private readonly IHttpContextAccessor _httpContextAccessor;
1730
private readonly IHttpUserAgentParserProvider _httpUserAgentParser;
1831

32+
/// <summary>
33+
/// Creates a new instance of <see cref="HttpUserAgentParserAccessor"/>
34+
/// </summary>
1935
public HttpUserAgentParserAccessor(IHttpContextAccessor httpContextAccessor, IHttpUserAgentParserProvider httpUserAgentParser)
2036
{
2137
_httpContextAccessor = httpContextAccessor;
2238
_httpUserAgentParser = httpUserAgentParser;
2339
}
2440

41+
/// <summary>
42+
/// User agent of current <see cref="IHttpContextAccessor"/>
43+
/// </summary>
2544
public string HttpContextUserAgent =>
2645
_httpContextAccessor.HttpContext?.Request?.Headers["User-Agent"].ToString()!;
2746

47+
/// <summary>
48+
/// Returns current <see cref="HttpUserAgentInformation"/> of current <see cref="IHttpContextAccessor"/>
49+
/// </summary>
2850
public HttpUserAgentInformation Get()
2951
=> _httpUserAgentParser.Parse(this.HttpContextUserAgent);
3052
}

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright © myCSharp 2020-2021, all rights reserved
1+
// Copyright © myCSharp 2020-2021, all rights reserved
22

33
using System;
44
using Microsoft.Extensions.DependencyInjection;
@@ -7,6 +7,9 @@
77

88
namespace MyCSharp.HttpUserAgentParser.MemoryCache.DependencyInjection
99
{
10+
/// <summary>
11+
/// Dependency injection extensions for IMemoryCache
12+
/// </summary>
1013
public static class HttpUserAgentParserMemoryCacheServiceCollectionExtensions
1114
{
1215
/// <summary>

src/MyCSharp.HttpUserAgentParser.MemoryCache/HttpUserAgentParserMemoryCachedProviderOptions.cs

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,31 @@ namespace MyCSharp.HttpUserAgentParser.MemoryCache
1414
/// </summary>
1515
public class HttpUserAgentParserMemoryCachedProviderOptions
1616
{
17+
/// <summary>
18+
/// Cache options
19+
/// </summary>
1720
public MemoryCacheOptions CacheOptions { get; }
21+
22+
/// <summary>
23+
/// Cache entry options
24+
/// </summary>
1825
public MemoryCacheEntryOptions CacheEntryOptions { get; }
1926

27+
/// <summary>
28+
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
29+
/// </summary>
2030
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheOptions cacheOptions)
2131
: this(cacheOptions, null) { }
2232

33+
/// <summary>
34+
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
35+
/// </summary>
2336
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheEntryOptions cacheEntryOptions)
2437
: this(null, cacheEntryOptions) { }
2538

39+
/// <summary>
40+
/// Creates a new instance of <see cref="HttpUserAgentParserMemoryCachedProviderOptions"/>
41+
/// </summary>
2642
public HttpUserAgentParserMemoryCachedProviderOptions(MemoryCacheOptions? cacheOptions = null, MemoryCacheEntryOptions? cacheEntryOptions = null)
2743
{
2844
this.CacheEntryOptions = cacheEntryOptions ?? new MemoryCacheEntryOptions

0 commit comments

Comments
 (0)