Skip to content

Add missing comments to documentation #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 missing comments to documentation #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
f12b6d9
Initial commit with task details for issue #29
konard Sep 14, 2025
9fa03d8
Add missing comments to documentation
konard Sep 14, 2025
16509ac
Remove CLAUDE.md - Claude command completed
konard Sep 14, 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
8 changes: 4 additions & 4 deletions csharp/Platform.Ranges/EnsureExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ public static void ArgumentInRange<TArgument>(this EnsureAlwaysExtensionRoot roo
/// </summary>
/// <typeparam name="TArgument"><para>Type of argument.</para><para>Тип аргумента.</para></typeparam>
/// <param name="root"><para>The extension root to which this method is bound.</para><para>Корень-расширения, к которому привязан этот метод.</para></param>
/// <param name="argument"></param>
/// <param name="argument"><para>The argument's value.</para><para>Значение аргумента.</para></param>
/// <param name="range"><para>The range restriction.</para><para>Ограничение в виде диапазона.</para></param>
/// <param name="argumentName"><para>The argument's name.</para><para>Имя аргумента.</para></param>
/// <param name="messageBuilder"><para>The thrown exception's message building <see cref="Func{String}"/>.</para><para>Собирающая сообщение для выбрасываемого исключения <see cref="Func{String}"/>.</para></param>
Expand All @@ -238,7 +238,7 @@ public static void ArgumentInRange<TArgument>(this EnsureAlwaysExtensionRoot roo
/// </summary>
/// <typeparam name="TArgument"><para>Type of argument.</para><para>Тип аргумента.</para></typeparam>
/// <param name="root"><para>The extension root to which this method is bound.</para><para>Корень-расширения, к которому привязан этот метод.</para></param>
/// <param name="argument"></param>
/// <param name="argument"><para>The argument's value.</para><para>Значение аргумента.</para></param>
/// <param name="range"><para>The range restriction.</para><para>Ограничение в виде диапазона.</para></param>
/// <param name="argumentName"><para>The argument's name.</para><para>Имя аргумента.</para></param>
/// <param name="message"><para>The message of the thrown exception.</para><para>Сообщение выбрасываемого исключения.</para></param>
Expand All @@ -251,7 +251,7 @@ public static void ArgumentInRange<TArgument>(this EnsureAlwaysExtensionRoot roo
/// </summary>
/// <typeparam name="TArgument"><para>Type of argument.</para><para>Тип аргумента.</para></typeparam>
/// <param name="root"><para>The extension root to which this method is bound.</para><para>Корень-расширения, к которому привязан этот метод.</para></param>
/// <param name="argument"></param>
/// <param name="argument"><para>The argument's value.</para><para>Значение аргумента.</para></param>
/// <param name="range"><para>The range restriction.</para><para>Ограничение в виде диапазона.</para></param>
/// <param name="argumentName"><para>The argument's name.</para><para>Имя аргумента.</para></param>
[Conditional("DEBUG")]
Expand Down Expand Up @@ -288,7 +288,7 @@ public static void ArgumentInRange<TArgument>(this EnsureAlwaysExtensionRoot roo
/// </summary>
/// <typeparam name="TArgument"><para>Type of argument.</para><para>Тип аргумента.</para></typeparam>
/// <param name="root"><para>The extension root to which this method is bound.</para><para>Корень-расширения, к которому привязан этот метод.</para></param>
/// <param name="argument"></param>
/// <param name="argument"><para>The argument's value.</para><para>Значение аргумента.</para></param>
/// <param name="range"><para>The range restriction.</para><para>Ограничение в виде диапазона.</para></param>
[Conditional("DEBUG")]
public static void ArgumentInRange<TArgument>(this EnsureOnDebugExtensionRoot root, TArgument argument, Range<TArgument> range) => Ensure.Always.ArgumentInRange(argument, range, null);
Expand Down
6 changes: 4 additions & 2 deletions csharp/Platform.Ranges/Range[T].cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ namespace Platform.Ranges
/// <para>Represents a range between minimum and maximum values.</para>
/// <para>Представляет диапазон между минимальным и максимальным значениями.</para>
/// </summary>
/// <typeparam name="T"><para>The type of the values that define the range bounds.</para><para>Тип значений, определяющих границы диапазона.</para></typeparam>
/// <remarks>
/// <para>Based on <a href="http://stackoverflow.com/questions/5343006/is-there-a-c-sharp-type-for-representing-an-integer-range">the question at StackOverflow</a>.</para>
/// <para>Основано на <a href="http://stackoverflow.com/questions/5343006/is-there-a-c-sharp-type-for-representing-an-integer-range">вопросе в StackOverflow</a>.</para>
Expand Down Expand Up @@ -118,9 +119,10 @@ public Range(T minimum, T maximum)
public override bool Equals(object obj) => obj is Range<T> range ? Equals(range) : false;

/// <summary>
/// Calculates the hash code for the current <see cref="Range{T}"/> instance.
/// <para>Calculates the hash code for the current <see cref="Range{T}"/> instance.</para>
/// <para>Вычисляет хэш-код для текущего экземпляра <see cref="Range{T}"/>.</para>
/// </summary>
/// <returns>The hash code for the current <see cref="Range{T}"/> instance.</returns>
/// <returns><para>The hash code for the current <see cref="Range{T}"/> instance.</para><para>Хэш-код для текущего экземпляра <see cref="Range{T}"/>.</para></returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public override int GetHashCode() => (Minimum, Maximum).GetHashCode();

Expand Down
Loading