Skip to content

Commit 6e2cc6e

Browse files
i4004i4004
committed
[add] missing XML comments
1 parent 7260754 commit 6e2cc6e

15 files changed

Lines changed: 161 additions & 1 deletion

‎src/Simplify.Web/Modules/Data/TemplateFactory.cs‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,18 @@ public sealed class TemplateFactory(IDynamicEnvironment environment,
3434

3535
private ILanguageManager _languageManager = null!;
3636

37+
/// <summary>
38+
/// Setups the template factory.
39+
/// </summary>
3740
public void Setup() => _languageManager = languageManagerProvider.Get();
3841

42+
/// <summary>
43+
/// Loads s template from a file.
44+
/// </summary>
45+
/// <param name="fileName">Template file name.</param>
46+
/// <returns>
47+
/// Template class with loaded template.
48+
/// </returns>
3949
public ITemplate Load(string fileName)
4050
{
4151
var filePath = BuildFilePath(fileName);
@@ -65,6 +75,10 @@ public ITemplate Load(string fileName)
6575
}
6676
}
6777

78+
/// <summary>
79+
/// Loads a web-site template from a file asynchronously.
80+
/// </summary>
81+
/// <param name="fileName">The file name.</param>
6882
public Task<ITemplate> LoadAsync(string fileName) => LoadAsyncInternal(fileName, Assembly.GetCallingAssembly());
6983

7084
private async Task<ITemplate> LoadAsyncInternal(string fileName, Assembly assembly)

‎src/Simplify.Web/Modules/Localization/ILanguageManager.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ public interface ILanguageManager
88
/// <summary>
99
/// Gets the application current language, for example: "en", "ru", "de" etc.
1010
/// </summary>
11+
/// <value>
12+
/// The language.
13+
/// </value>
1114
string Language { get; }
1215

1316
/// <summary>

‎src/Simplify.Web/Modules/Localization/LanguageManager.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ namespace Simplify.Web.Modules.Localization;
1010
/// <summary>
1111
/// Provides the application language handler and information container.
1212
/// </summary>
13+
/// <seealso cref="ILanguageManager" />
1314
public class LanguageManager : ILanguageManager
1415
{
1516
/// <summary>

‎src/Simplify.Web/Modules/Localization/LanguageManagerProvider.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ namespace Simplify.Web.Modules.Localization;
66
/// <summary>
77
/// Provides the language manager provider.
88
/// </summary>
9+
/// <seealso cref="ILanguageManagerProvider" />
910
/// <remarks>
1011
/// Initializes a new instance of the <see cref="LanguageManagerProvider" /> class.
1112
/// </remarks>

‎src/Simplify.Web/Modules/Redirection/IRedirector.cs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,33 @@ public interface IRedirector
88
/// <summary>
99
/// Gets or sets the previous page url.
1010
/// </summary>
11+
/// <value>
12+
/// The previous page URL.
13+
/// </value>
1114
string? PreviousPageUrl { get; set; }
1215

1316
/// <summary>
1417
/// Gets or sets the redirect url.
1518
/// </summary>
19+
/// <value>
20+
/// The redirect URL.
21+
/// </value>
1622
string? RedirectUrl { get; set; }
1723

1824
/// <summary>
1925
/// Gets the login return URL.
2026
/// </summary>
27+
/// <value>
28+
/// The login return URL.
29+
/// </value>
2130
string? LoginReturnUrl { get; set; }
2231

2332
/// <summary>
2433
/// Gets or sets the previous navigated URL.
2534
/// </summary>
35+
/// <value>
36+
/// The previous navigated URL.
37+
/// </value>
2638
string? PreviousNavigatedUrl { get; set; }
2739

2840
/// <summary>

‎src/Simplify.Web/Modules/Redirection/RedirectionType.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
namespace Simplify.Web.Modules.Redirection;
22

33
/// <summary>
4-
/// Provides redirection types.
4+
/// Provides the redirection types.
55
/// </summary>
66
public enum RedirectionType
77
{

‎src/Simplify.Web/Modules/Redirection/Redirector.cs‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,38 @@
66

77
namespace Simplify.Web.Modules.Redirection;
88

9+
/// <summary>
10+
/// Provides the redirector.
11+
/// </summary>
12+
/// <seealso cref="IRedirector" />
913
public class Redirector(IWebContext context) : IRedirector
1014
{
15+
/// <summary>
16+
/// The previous page URL cookie field name
17+
/// </summary>
1118
public const string PreviousPageUrlCookieFieldName = "PreviousPageUrl";
1219

20+
/// <summary>
21+
/// The redirect URL cookie field name
22+
/// </summary>
1323
public const string RedirectUrlCookieFieldName = "RedirectUrl";
1424

25+
/// <summary>
26+
/// The login return URL cookie field name
27+
/// </summary>
1528
public const string LoginReturnUrlCookieFieldName = "LoginReturnUrl";
1629

30+
/// <summary>
31+
/// The previous navigated URL cookie field name
32+
/// </summary>
1733
public const string PreviousNavigatedUrlCookieFieldName = "PreviousNavigatedUrl";
1834

35+
/// <summary>
36+
/// Gets or sets the previous page url.
37+
/// </summary>
38+
/// <value>
39+
/// The previous page URL.
40+
/// </value>
1941
public string? PreviousPageUrl
2042
{
2143
get => context.Request.Cookies[PreviousPageUrlCookieFieldName];
@@ -26,6 +48,12 @@ public string? PreviousPageUrl
2648
});
2749
}
2850

51+
/// <summary>
52+
/// Gets or sets the redirect url.
53+
/// </summary>
54+
/// <value>
55+
/// The redirect URL.
56+
/// </value>
2957
public string? RedirectUrl
3058
{
3159
get => context.Request.Cookies[RedirectUrlCookieFieldName];
@@ -36,6 +64,12 @@ public string? RedirectUrl
3664
});
3765
}
3866

67+
/// <summary>
68+
/// Gets the login return URL.
69+
/// </summary>
70+
/// <value>
71+
/// The login return URL.
72+
/// </value>
3973
public string? LoginReturnUrl
4074
{
4175
get => context.Request.Cookies[LoginReturnUrlCookieFieldName];
@@ -46,6 +80,12 @@ public string? LoginReturnUrl
4680
});
4781
}
4882

83+
/// <summary>
84+
/// Gets or sets the previous navigated URL.
85+
/// </summary>
86+
/// <value>
87+
/// The previous navigated URL.
88+
/// </value>
4989
public string? PreviousNavigatedUrl
5090
{
5191
get => context.Request.Cookies[PreviousNavigatedUrlCookieFieldName];
@@ -56,12 +96,27 @@ public string? PreviousNavigatedUrl
5696
});
5797
}
5898

99+
/// <summary>
100+
/// Sets the redirect url to current page.
101+
/// </summary>
59102
public void SetRedirectUrlToCurrentPage() => RedirectUrl = context.Request.GetEncodedUrl();
60103

104+
/// <summary>
105+
/// Sets the login return URL from current URI.
106+
/// </summary>
61107
public void SetLoginReturnUrlFromCurrentUri() => LoginReturnUrl = context.Request.GetEncodedUrl();
62108

109+
/// <summary>
110+
/// Sets the previous page URL to current page.
111+
/// </summary>
63112
public void SetPreviousPageUrlToCurrentPage() => PreviousPageUrl = context.Request.GetEncodedUrl();
64113

114+
/// <summary>
115+
/// Navigates the client by specifying redirection type.
116+
/// </summary>
117+
/// <param name="redirectionType">Type of the redirection.</param>
118+
/// <param name="bookmarkName">Name of the bookmark.</param>
119+
/// <exception cref="ArgumentOutOfRangeException">redirectionType - null</exception>
65120
public void Redirect(RedirectionType redirectionType, string? bookmarkName = null)
66121
{
67122
PreviousNavigatedUrl = context.Request.GetEncodedUrl();
@@ -97,6 +152,12 @@ public void Redirect(RedirectionType redirectionType, string? bookmarkName = nul
97152
}
98153
}
99154

155+
/// <summary>
156+
/// Redirects the client to specified URL.
157+
/// </summary>
158+
/// <param name="url">The URL.</param>
159+
/// <exception cref="ArgumentNullException">url</exception>
160+
/// <exception cref="SecurityException">Redirection outside the website, redirection URL: " + url</exception>
100161
public void Redirect(string? url)
101162
{
102163
if (string.IsNullOrEmpty(url))

‎src/Simplify.Web/Page/Composition/IPageCompositionStage.cs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22

33
namespace Simplify.Web.Page.Composition;
44

5+
/// <summary>
6+
/// Represents a page composition stage.
7+
/// </summary>
58
public interface IPageCompositionStage
69
{
10+
/// <summary>
11+
/// Executes this stage.
12+
/// </summary>
13+
/// <param name="dataCollector">The data collector.</param>
714
void Execute(IDataCollector dataCollector);
815
}

‎src/Simplify.Web/Page/Composition/PageComposer.cs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44

55
namespace Simplify.Web.Page.Composition;
66

7+
/// <summary>
8+
/// Provides the page composer.
9+
/// </summary>
10+
/// <seealso cref="PageComposer" />
711
public class PageComposer(IReadOnlyList<IPageCompositionStage> stages, IDataCollector dataCollector, IPageGenerator pageGenerator) : IPageComposer
812
{
13+
/// <summary>
14+
/// Composes the current web-page.
15+
/// </summary>
916
public string Compose()
1017
{
1118
foreach (var item in stages)

‎src/Simplify.Web/Page/Composition/Stages/ContextVariablesInjectionStage.cs‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33

44
namespace Simplify.Web.Page.Composition.Stages;
55

6+
/// <summary>
7+
/// Provides the context variables injection stage.
8+
/// </summary>
9+
/// <seealso cref="IPageCompositionStage" />
610
public class ContextVariablesInjectionStage(IWebContextProvider webContextProvider) : IPageCompositionStage
711
{
812
/// <summary>
@@ -15,6 +19,10 @@ public class ContextVariablesInjectionStage(IWebContextProvider webContextProvid
1519
/// </summary>
1620
public const string VariableNameSiteVirtualPath = "~";
1721

22+
/// <summary>
23+
/// Executes this stage.
24+
/// </summary>
25+
/// <param name="dataCollector">The data collector.</param>
1826
public void Execute(IDataCollector dataCollector)
1927
{
2028
var context = webContextProvider.Get();

0 commit comments

Comments
 (0)