Skip to content

Add XML documentation comments for all public classes and methods #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
konard wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add XML documentation comments for all public classes and methods #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b18ec7
Initial commit with task details for issue #53
konard Sep 13, 2025
42e7418
Complete XML documentation for all public classes and methods
konard Sep 13, 2025
aa96fab
Remove CLAUDE.md - Claude command completed
konard Sep 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion csharp/Platform.Reflection/AssemblyExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using Platform.Exceptions;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand All @@ -19,6 +18,20 @@ public static class AssemblyExtensions
{
private static readonly ConcurrentDictionary<Assembly, Type[]> _loadableTypesCache = new ConcurrentDictionary<Assembly, Type[]>();

/// <summary>
/// <para>
/// Gets the loadable types using the specified assembly.
/// </para>
/// <para></para>
/// </summary>
/// <param name="assembly">
/// <para>The assembly.</para>
/// <para></para>
/// </param>
/// <returns>
/// <para>The type array</para>
/// <para></para>
/// </returns>
/// <remarks>
/// Source: http://haacked.com/archive/2012/07/23/get-all-types-in-an-assembly.aspx/
/// </remarks>
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/DelegateHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using System.Runtime.CompilerServices;
using Platform.Exceptions;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
3 changes: 1 addition & 2 deletions csharp/Platform.Reflection/DynamicExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
using System.Collections.Generic;
using System.Runtime.CompilerServices;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand All @@ -19,7 +18,7 @@ public static class DynamicExtensions
/// </para>
/// <para></para>
/// </summary>
/// <param name="@object">
/// <param name="object">
/// <para>The object.</para>
/// <para></para>
/// </param>
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/EnsureExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using Platform.Exceptions.ExtensionRoots;

#pragma warning disable IDE0060 // Remove unused parameter
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/FieldInfoExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
using System.Reflection;
using System.Runtime.CompilerServices;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/ILGeneratorExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
using System.Reflection.Emit;
using System.Runtime.CompilerServices;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/MethodInfoExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
using System.Reflection;
using System.Runtime.CompilerServices;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/NotSupportedExceptionDelegateFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
using System.Runtime.CompilerServices;
using Platform.Interfaces;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
3 changes: 1 addition & 2 deletions csharp/Platform.Reflection/NumericType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
// ReSharper disable AssignmentInConditionalExpression
// ReSharper disable BuiltInTypeReferenceStyle
// ReSharper disable StaticFieldInGenericType
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down Expand Up @@ -112,7 +111,7 @@ public static class NumericType<T>

/// <summary>
/// <para>
/// Initializes a new <see cref="NumericType"/> instance.
/// Initializes a new <see cref="NumericType{T}"/> instance.
/// </para>
/// <para></para>
/// </summary>
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/PropertyInfoExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
using System.Reflection;
using System.Runtime.CompilerServices;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/TypeBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

using System;
using System.Reflection;
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/TypeExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using System.Runtime.CompilerServices;
using Platform.Collections;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

namespace Platform.Reflection
{
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
using System.Runtime.CompilerServices;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types[T1, T2, T3, T4, T5, T6, T7].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.ObjectModel;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types[T1, T2, T3, T4, T5, T6].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.ObjectModel;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types[T1, T2, T3, T4, T5].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.ObjectModel;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types[T1, T2, T3, T4].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.ObjectModel;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types[T1, T2, T3].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.ObjectModel;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types[T1, T2].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.ObjectModel;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
1 change: 0 additions & 1 deletion csharp/Platform.Reflection/Types[T].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
using System.Collections.ObjectModel;
using Platform.Collections.Lists;

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
#pragma warning disable CA1819 // Properties should not return arrays

namespace Platform.Reflection
Expand Down
Loading