Skip to content

Utilize comments in ILinks.cs by standardizing XML documentation #172

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

Utilize comments in ILinks.cs by standardizing XML documentation #172

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad2a0f3
Initial commit with task details for issue #15
konard Sep 14, 2025
f6b3ede
Utilize comments in ILinks.cs by standardizing XML documentation
konard Sep 14, 2025
fbc865a
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
13 changes: 5 additions & 8 deletions csharp/Platform.Data/ILinks.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.Delegates;

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

namespace Platform.Data
{
Expand Down Expand Up @@ -92,16 +91,14 @@ TConstants Constants
TLinkAddress Create(IList<TLinkAddress>? substitution, WriteHandler<TLinkAddress>? handler);

/// <summary>
/// Обновляет связь с указанными restriction[Constants.IndexPart] в адресом связи
/// на связь с указанным новым содержимым.
/// <para>Updates a link with the specified restriction[Constants.IndexPart] containing the link address to a link with the specified new content.</para>
/// <para>Обновляет связь с указанными restriction[Constants.IndexPart] в адресом связи на связь с указанным новым содержимым.</para>
/// </summary>
/// <param name="restriction">
/// Ограничение на содержимое связей.
/// Предполагается, что будет указан индекс связи (в restriction[Constants.IndexPart]) и далее за ним будет следовать содержимое связи.
/// Каждое ограничение может иметь значения: Constants.Null - 0-я связь, обозначающая ссылку на пустоту,
/// Constants.Itself - требование установить ссылку на себя, 1..∞ конкретный индекс другой связи.
/// <para>Restriction on the contents of links. It is assumed that the link index will be specified (in restriction[Constants.IndexPart]) and then the link content will follow. Each constraint can have values: Constants.Null - the 0th link denoting a reference to the void, Constants.Itself - a requirement to set a reference to itself, 1..∞ a specific index of another link.</para>
/// <para>Ограничение на содержимое связей. Предполагается, что будет указан индекс связи (в restriction[Constants.IndexPart]) и далее за ним будет следовать содержимое связи. Каждое ограничение может иметь значения: Constants.Null - 0-я связь, обозначающая ссылку на пустоту, Constants.Itself - требование установить ссылку на себя, 1..∞ конкретный индекс другой связи.</para>
/// </param>
/// <param name="substitution"></param>
/// <param name="substitution"><para>The new content of the link.</para><para>Новое содержимое связи.</para></param>
/// <param name="handler">
/// <para>A function to handle each executed change. This function can use Constants.Continue to continue proccess each change. Constants.Break can be used to stop receiving of executed changes.</para>
/// <para>Функция для обработки каждого выполненного изменения. Эта функция может использовать Constants.Continue чтобы продолжить обрабатывать каждое изменение. Constants.Break может быть использована для остановки получения выполненных изменений.</para>
Expand Down
Loading