Skip to content

Commit 11063ed

Browse files
committed
[add] missing XML comments
[r] method name [del] unused variable
1 parent 1f05342 commit 11063ed

10 files changed

Lines changed: 66 additions & 6 deletions

src/Simplify.Web/ActionModulesAccessor.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ namespace Simplify.Web;
88
/// <summary>
99
/// Provides the action modules accessor base class.
1010
/// </summary>
11+
/// <seealso cref="ModulesAccessor" />
1112
public abstract class ActionModulesAccessor : ModulesAccessor
1213
{
1314
/// <summary>

src/Simplify.Web/System/AssembliesFilterExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace Simplify.Web.System;
77

88
/// <summary>
9-
/// Provides the Assembly filter extensions
9+
/// Provides the <see cref="Assembly" /> filter extensions.
1010
/// </summary>
1111
public static class AssembliesFilterExtensions
1212
{

src/Simplify.Web/System/ReadOnyDictionaryExtensions.cs

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

44
namespace Simplify.Web.System;
55

6+
/// <summary>
7+
/// Provides the dictionary extensions.
8+
/// </summary>
69
public static class DictionaryExtensions
710
{
11+
/// <summary>
12+
/// Converts to dictionary to <see cref="ExpandoObject" />.
13+
/// </summary>
14+
/// <param name="dictionary">The dictionary.</param>
815
public static ExpandoObject ToExpandoObject(this IReadOnlyDictionary<string, object> dictionary)
916
{
1017
var expando = new ExpandoObject();

src/Simplify.Web/System/SimplifyWebTypesFinder.cs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,20 @@ public static class SimplifyWebTypesFinder
5050
/// <summary>
5151
/// Finds the all types derived from specified type in the current domain assemblies.
5252
/// </summary>
53-
/// <typeparam name="T"></typeparam>
53+
/// <typeparam name="T">The type.</typeparam>
5454
public static IEnumerable<Type> FindTypesDerivedFrom<T>() => FindTypesDerivedFrom(typeof(T));
5555

56+
/// <summary>
57+
/// Finds the types derived from.
58+
/// </summary>
59+
/// <param name="types">The types.</param>
5660
public static IEnumerable<Type> FindTypesDerivedFrom(IEnumerable<Type> types) => types
5761
.SelectMany(FindTypesDerivedFrom);
5862

63+
/// <summary>
64+
/// Finds the types derived from.
65+
/// </summary>
66+
/// <param name="types">The types.</param>
5967
public static IEnumerable<Type> FindTypesDerivedFrom(params Type[] types) => types
6068
.SelectMany(FindTypesDerivedFrom);
6169

@@ -100,7 +108,7 @@ public static IList<Type> GetIgnoredIocRegistrationTypes()
100108
}
101109

102110
/// <summary>
103-
/// Clean up the loaded information about assemblies and types
111+
/// Clean up the loaded information about assemblies and types.
104112
/// </summary>
105113
public static void CleanLoadedTypesAndAssembliesInfo()
106114
{

src/Simplify.Web/System/StringConverter.cs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@
44

55
namespace Simplify.Web.System;
66

7+
/// <summary>
8+
/// Provides the string converter.
9+
/// </summary>
710
public static class StringConverter
811
{
12+
/// <summary>
13+
/// Provides the value converters list
14+
/// </summary>
915
public static readonly IReadOnlyDictionary<Type, Func<string, object?>> ValueConverters =
10-
new Dictionary<Type, Func<string, object?>>()
16+
new Dictionary<Type, Func<string, object?>>
1117
{
1218
{ typeof(string), sourceValue => sourceValue },
1319
{ typeof(int), GetIntParameterValue },
@@ -22,6 +28,11 @@ public static class StringConverter
2228
{ typeof(bool[]), GetBoolArrayParameterValue }
2329
};
2430

31+
/// <summary>
32+
/// Tries the convert the string to the object of specified type.
33+
/// </summary>
34+
/// <param name="destinationType">Type of the destination.</param>
35+
/// <param name="sourceValue">The source value.</param>
2536
public static object? TryConvert(Type destinationType, string sourceValue) =>
2637
ValueConverters.TryGetValue(destinationType, out var converter)
2738
? converter(sourceValue)

src/Simplify.Web/System/StringExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace Simplify.Web.System;
55

66
/// <summary>
7-
/// Provides String extensions
7+
/// Provides the <see cref="string" /> extensions.
88
/// </summary>
99
public static class StringExtensions
1010
{

src/Simplify.Web/System/TypeExtensions.cs

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
namespace Simplify.Web.System;
66

77
/// <summary>
8-
/// Provides the Type extensions
8+
/// Provides the <see cref="Type" /> extensions.
99
/// </summary>
1010
public static class TypeExtensions
1111
{
@@ -27,8 +27,24 @@ public static bool IsTypeOf(this Type t, Type type)
2727
}
2828
}
2929

30+
/// <summary>
31+
/// Determines whether the type is derived from one of the specified types.
32+
/// </summary>
33+
/// <param name="t">The t.</param>
34+
/// <param name="types">The types.</param>
35+
/// <returns>
36+
/// <c>true</c> if the type is derived from one of the specified types; otherwise, <c>false</c>.
37+
/// </returns>
3038
public static bool IsDerivedFrom(this Type t, params Type[] types) => types.Any(t.IsDerivedFrom);
3139

40+
/// <summary>
41+
/// Determines whether the type is derived from other type.
42+
/// </summary>
43+
/// <param name="t">The t.</param>
44+
/// <param name="type">The type.</param>
45+
/// <returns>
46+
/// <c>true</c> if the type is derived from other type; otherwise, <c>false</c>.
47+
/// </returns>
3248
public static bool IsDerivedFrom(this Type t, Type type)
3349
{
3450
if (t.IsAbstract)
@@ -49,5 +65,9 @@ public static bool IsDerivedFrom(this Type t, Type type)
4965
return false;
5066
}
5167

68+
/// <summary>
69+
/// Gets the type names as string.
70+
/// </summary>
71+
/// <param name="types">The types.</param>
5272
public static string GetTypeNamesAsString(this IEnumerable<Type> types) => string.Join(", ", types.Select(type => type.Name));
5373
}

src/Simplify.Web/Views/Meta/IViewsMetaStore.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,8 @@ public interface IViewsMetaStore
1111
/// <summary>
1212
/// Gets the current domain views types
1313
/// </summary>
14+
/// <value>
15+
/// The views types list.
16+
/// </value>
1417
IList<Type> ViewsTypes { get; }
1518
}

src/Simplify.Web/Views/Meta/ViewsMetaStore.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ namespace Simplify.Web.Views.Meta;
88
/// <summary>
99
/// Provides the views meta information store.
1010
/// </summary>
11+
/// <seealso cref="IViewsMetaStore" />
1112
public class ViewsMetaStore : IViewsMetaStore
1213
{
1314
private static IViewsMetaStore? _current;
@@ -16,6 +17,10 @@ public class ViewsMetaStore : IViewsMetaStore
1617
/// <summary>
1718
/// Gets the current views meta store.
1819
/// </summary>
20+
/// <value>
21+
/// The current.
22+
/// </value>
23+
/// <exception cref="ArgumentNullException">value</exception>
1924
public static IViewsMetaStore Current
2025
{
2126
get => _current ??= new ViewsMetaStore();
@@ -25,6 +30,9 @@ public static IViewsMetaStore Current
2530
/// <summary>
2631
/// Gets the current domain views types.
2732
/// </summary>
33+
/// <value>
34+
/// The views types list.
35+
/// </value>
2836
public IList<Type> ViewsTypes
2937
{
3038
get

src/Simplify.Web/Views/ViewFactory.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ namespace Simplify.Web.Views;
1010
/// <summary>
1111
/// Provides the view factory.
1212
/// </summary>
13+
/// <seealso cref="ModulesAccessorInjector" />
14+
/// <seealso cref="IViewFactory" />
1315
public class ViewFactory(IDIResolver resolver) : ModulesAccessorInjector(resolver), IViewFactory
1416
{
1517
private readonly IDIResolver _resolver = resolver;

0 commit comments

Comments
 (0)