-
Notifications
You must be signed in to change notification settings - Fork 7
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.
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
AllSegmentsWalkerBase new documentation #137
base: main
Are you sure you want to change the base?
Changes from 26 commits
d5ffa31
8b3574c
15e2219
1aedf15
7794022
1e58742
612af57
d325d15
b598dd9
0f9964a
3c54612
eeb35b3
56a0b4c
55e6fae
f541c3f
ccbd3c7
f275571
6ce8fe7
1c0eade
90dd4ce
804cd45
bc38b9a
57c4fdc
2af9353
79f9aa3
1ec0d84
292c04c
d22f982
27baa4c
c40fddc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -3,19 +3,15 @@ | |||||
namespace Platform.Collections.Segments.Walkers | ||||||
{ | ||||||
/// <summary> | ||||||
/// <para> | ||||||
/// Represents the all segments walker base. | ||||||
/// </para> | ||||||
/// <para></para> | ||||||
/// <para>Represents a base class for walkers through all possible segments of a sequence.</para> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
/// <para>Представляет базовый класс для проходчиков по всем возможным сегментам последовательности.</para> | ||||||
/// </summary> | ||||||
Konard marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
public abstract class AllSegmentsWalkerBase | ||||||
{ | ||||||
/// <summary> | ||||||
/// <para> | ||||||
/// The default minimum string segment length. | ||||||
/// </para> | ||||||
/// <para></para> | ||||||
/// <para>A read-only field that represents the default minimum length of the sequence segment.</para> | ||||||
/// <para>Поле только для чтения, которое представляет минимальную длину сегмента последовательности по умолчанию.</para> | ||||||
/// </summary> | ||||||
public static readonly int DefaultMinimumStringSegmentLength = 2; | ||||||
} | ||||||
} | ||||||
} |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -6,37 +6,37 @@ | |||||
namespace Platform.Collections.Segments.Walkers | ||||||
{ | ||||||
/// <summary> | ||||||
/// <para> | ||||||
/// Represents the all segments walker base. | ||||||
/// </para> | ||||||
/// <para></para> | ||||||
/// <para>Represents the base class for sinkers for all possible segments of the sequence.</para> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
/// <para>Представляет базовый класс для проходчиков по всем возможным сегментам последовательности.</para> | ||||||
/// </summary> | ||||||
/// <seealso cref="AllSegmentsWalkerBase{T, Segment{T}}"/> | ||||||
Konard marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
/// <typeparam name="T"> | ||||||
/// <para>The sequence's element type.</para> | ||||||
/// <para>Тип элемента последовательности.</para> | ||||||
/// </typeparam> | ||||||
public abstract class AllSegmentsWalkerBase<T> : AllSegmentsWalkerBase<T, Segment<T>> | ||||||
FreePhoenix888 marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
{ | ||||||
/// <summary> | ||||||
/// <para> | ||||||
/// Creates the segment using the specified elements. | ||||||
/// </para> | ||||||
/// <para></para> | ||||||
/// <para>Create a new instance of the <see cref="Segment"/> class based on <paramref name="elements"/> sequence.</para> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
/// <para>Создаёт новый экземпляр класса <see cref="Segment"/> на основе последовательности <paramref name="elements"/>.</para> | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
/// </summary> | ||||||
/// <param name="elements"> | ||||||
/// <para>The elements.</para> | ||||||
/// <para></para> | ||||||
/// <para>A list of elements.</para> | ||||||
/// <para>Список элементов.</para> | ||||||
/// </param> | ||||||
/// <param name="offset"> | ||||||
/// <para>The offset.</para> | ||||||
/// <para></para> | ||||||
/// <para>An offset relative to the <paramref name="elements"/> sequence from which the segment starts.</para> | ||||||
/// <para>Смещение относительно списка <paramref name="elements"/>, с которого начинается сегмент.</para> | ||||||
TwinkmrMask marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
/// </param> | ||||||
/// <param name="length"> | ||||||
/// <para>The length.</para> | ||||||
/// <para></para> | ||||||
/// <para>A segment's length.</para> | ||||||
/// <para>Длина сегмента.</para> | ||||||
/// </param> | ||||||
/// <returns> | ||||||
/// <para>A segment of t</para> | ||||||
/// <para></para> | ||||||
/// <para>An instance of the <see cref="Segment{T}"/> class.</para> | ||||||
/// <para>Экземпляр класса <see cref="Segment{T}"/>.</para> | ||||||
Konard marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
/// </returns> | ||||||
[MethodImpl(MethodImplOptions.AggressiveInlining)] | ||||||
protected override Segment<T> CreateSegment(IList<T> elements, int offset, int length) => new Segment<T>(elements, offset, length); | ||||||
} | ||||||
} | ||||||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove the pragma statement above because XML comments are not missing now