Skip to content
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

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
d5ffa31
Documentation for file AllSegmentsWalkerBase
kiritozevs Aug 26, 2021
8b3574c
Documentation for file AllSegmentsWalkerBase
kiritozevs Aug 26, 2021
15e2219
new documentation for a AllSegmentsWalkerBase[T]
kiritozevs Aug 27, 2021
1aedf15
new documentation for a AllSegmentsWalkerBase[T]
kiritozevs Aug 27, 2021
7794022
New version
kiritozevs Aug 27, 2021
1e58742
New version2
kiritozevs Aug 27, 2021
612af57
New version3
kiritozevs Aug 27, 2021
d325d15
Opa Gan Gnam Style
kiritozevs Aug 28, 2021
b598dd9
Opa Gan Gnam Style2
kiritozevs Aug 28, 2021
0f9964a
Opa Gan Gnam Style3
kiritozevs Aug 28, 2021
3c54612
Opa Gan Gnam Style 2.1
kiritozevs Aug 28, 2021
eeb35b3
new elemets param text
kiritozevs Aug 29, 2021
56a0b4c
new elemets param text2
kiritozevs Aug 29, 2021
55e6fae
100 Thousand Hour Leter
kiritozevs Aug 29, 2021
f541c3f
Probel
kiritozevs Aug 29, 2021
ccbd3c7
Delete Probel
kiritozevs Aug 30, 2021
f275571
This
kiritozevs Sep 2, 2021
6ce8fe7
This2
kiritozevs Sep 2, 2021
1c0eade
Meybe_Last
kiritozevs Sep 3, 2021
90dd4ce
Return
kiritozevs Sep 3, 2021
804cd45
konstantin
kiritozevs Sep 4, 2021
bc38b9a
new_english_new_files
kiritozevs Sep 4, 2021
57c4fdc
new_english_new_files2
kiritozevs Sep 4, 2021
2af9353
New_Commit
kiritozevs Sep 4, 2021
79f9aa3
new_text
kiritozevs Sep 10, 2021
1ec0d84
extra-puper-probel
kiritozevs Sep 11, 2021
292c04c
{T}
kiritozevs Sep 11, 2021
d22f982
6_and_9_string
kiritozevs Sep 18, 2021
27baa4c
seealso_in_3_files
kiritozevs Sep 22, 2021
c40fddc
t_tsegment_class_documentation
kiritozevs Sep 22, 2021
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,16 @@
namespace Platform.Collections.Segments.Walkers
Copy link
Member

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

{
/// <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>
Copy link
Member

Choose a reason for hiding this comment

The 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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A read-only field that represents ...
... the default minimum sequence segment length.

/// <para>Возвращает минимально допустимую длину сегмента.</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <para>Возвращает минимально допустимую длину сегмента.</para>
/// <para>Минимально допустимая длина сегмента.</para>

Copy link
Member

Choose a reason for hiding this comment

The 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
Expand Up @@ -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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <para>Представляет базовый абстрактный класс для проходчиков по всем элементам.</para>
/// <para>Базовый абстрактный класс для проходчиков по всем элементам.</para>

/// </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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a constructor, but a virtual method.

Suggested change
/// <para>Инициализирует новый экземпляр класса <see cref="Segment"/> .</para>
/// <para>Создаёт новый экземпляр класса <see cref="Segment{T}"/> на основе последовательности <paramref name="elements"/>.</para>

/// </summary>
/// <param name="elements">
/// <para>The elements.</para>
/// <para></para>
/// <para>List of elements.</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <para>List of elements.</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 start of the <paramref name="elements"/> from which the segment starts.</para>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// <para>An offset relative to the start of the <paramref name="elements"/> from which the segment starts.</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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An extra space before the dot, as well as on line 17

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also an extra space on line 21

Copy link
Member

Choose a reason for hiding this comment

The 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);
}
}
}