-
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 20 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,16 @@ | |||||
namespace Platform.Collections.Segments.Walkers | ||||||
{ | ||||||
/// <summary> | ||||||
/// <para> | ||||||
/// Represents the all segments walker base. | ||||||
/// </para> | ||||||
/// <para></para> | ||||||
/// <para>Represents the base abstract class for walkers on all elements.</para> | ||||||
/// <para>Представляет базовый класс для проходчиков по всем элементам.</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. ... по всем возможным сегментам последовательности. |
||||||
/// </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>Gets a default minimum length of the string segment.</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. A read-only field that represents ... |
||||||
/// <para>Возвращает минимально допустимую длину сегмента.</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
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. Поле только для чтения, которое представляет ... |
||||||
/// </summary> | ||||||
public static readonly int DefaultMinimumStringSegmentLength = 2; | ||||||
} | ||||||
} | ||||||
|
||||||
Konard marked this conversation as resolved.
Show resolved
Hide resolved
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -6,37 +6,33 @@ | |||||
namespace Platform.Collections.Segments.Walkers | ||||||
{ | ||||||
/// <summary> | ||||||
/// <para> | ||||||
/// Represents the all segments walker base. | ||||||
/// </para> | ||||||
/// <para></para> | ||||||
/// <para>Represents the base abstract class for walkers on all elements.</para> | ||||||
/// <para>Представляет базовый абстрактный класс для проходчиков по всем элементам.</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> | ||||||
/// <seealso cref="AllSegmentsWalkerBase{T, Segment{T}}"/> | ||||||
Konard marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
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>Initializes a new instance of the <see cref="Segment"/> class.</para> | ||||||
/// <para>Инициализирует новый экземпляр класса <see cref="Segment"/> .</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. This is not a constructor, but a virtual method.
Suggested change
|
||||||
/// </summary> | ||||||
/// <param name="elements"> | ||||||
/// <para>The elements.</para> | ||||||
/// <para></para> | ||||||
/// <para>List of 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
|
||||||
/// <para>Список элементов.</para> | ||||||
/// </param> | ||||||
/// <param name="offset"> | ||||||
/// <para>The offset.</para> | ||||||
/// <para></para> | ||||||
/// <para>An offset relative to the start of the <paramref name="elements"/> from which the segment starts.</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>Смещение относительно списка <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> | ||||||
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. An extra space before the dot, as well as on line 17 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. Also an extra space on line 21 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. Remove extra space |
||||||
/// </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