AllSegmentsWalkerBase new documentation

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase.cs

@@ -3,19 +3,17 @@
 namespace Platform.Collections.Segments.Walkers
 {
     /// <summary>
-    /// <para>
-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base class for walkers through all possible segments of a sequence.</para>
+    /// <para>Представляет базовый класс для проходчиков по всем возможным сегментам последовательности.</para> 
     /// </summary>
+    /// <seealso cref="AllSegmentsWalkerBase{T, Segment{T}}"/>
+    /// <seealso cref="AllSegmentsWalkerBase{T}"/>
     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;
     }
-}
+}

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T, TSegment].cs

@@ -6,41 +6,34 @@
 namespace Platform.Collections.Segments.Walkers
 {
     /// <summary>
-    /// <para>
-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base class for walkers through all possible segments of a sequence.</para>
+    /// <para>Представляет базовый класс для проходчиков по всем возможным сегментам последовательности.</para>
     /// </summary>
     /// <seealso cref="AllSegmentsWalkerBase"/>
+    /// <seealso cref="AllSegmentsWalkerBase{T}"/>
     public abstract class AllSegmentsWalkerBase<T, TSegment> : AllSegmentsWalkerBase
         where TSegment : Segment<T>
     {
         /// <summary>
-        /// <para>
-        /// The minimum string segment length.
-        /// </para>
-        /// <para></para>
+        /// <para>A read-only field that represents the minimum length of the sequence segment.</para>
+        /// <para>Поле только для чтения, которое представляет минимальную длину сегмента последовательности.</para>
         /// </summary>
         private readonly int _minimumStringSegmentLength;
 
         /// <summary>
-        /// <para>
-        /// Initializes a new <see cref="AllSegmentsWalkerBase"/> instance.
-        /// </para>
-        /// <para></para>
+        /// <para>Constructor that initializes the field <see cref="_minimumStringSegmentLength"/>, inserts the default value there.</para>
+        /// <para>Конструктор, который инициализирует поле <see cref="_minimumStringSegmentLength"/> , вставляет туда значение по умолчанию.</para>
         /// </summary>
         /// <param name="minimumStringSegmentLength">
-        /// <para>A minimum string segment length.</para>
-        /// <para></para>
+        /// <para>The parameter that takes a field <see cref="DefaultMinimumStringSegmentLength"/>.</para>
+        /// <para>Параметр, принимающий поле <see cref="DefaultMinimumStringSegmentLength"/>.</para>
         /// </param>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         protected AllSegmentsWalkerBase(int minimumStringSegmentLength) => _minimumStringSegmentLength = minimumStringSegmentLength;
 
         /// <summary>
-        /// <para>
-        /// Initializes a new <see cref="AllSegmentsWalkerBase"/> instance.
-        /// </para>
-        /// <para></para>
+        /// <para>Constructor referencing another constructor by passing a field to its parameter <see cref="DefaultMinimumStringSegmentLength"/>.</para>
+        /// <para>Конструктор, ссылающийся на другой конструктор, передавая в его параметр поле <see cref="DefaultMinimumStringSegmentLength"/>.</para>
         /// </summary>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         protected AllSegmentsWalkerBase() : this(DefaultMinimumStringSegmentLength) { }
@@ -71,23 +64,23 @@ public virtual void WalkAll(IList<T> elements)
         /// <para>
         /// Creates the segment using the specified elements.
         /// </para>
-        /// <para></para>
+        /// <para>Представляет базовый метод, для всех методов создания мегмента.</para>
         /// </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>
         /// </param>
-        /// <param name="length">
-        /// <para>The length.</para>
-        /// <para></para>
+         /// <param name="length">
+        /// <para>A segment's length.</para>
+        /// <para>Длина сегмента.</para>
         /// </param>
         /// <returns>
-        /// <para>The segment</para>
-        /// <para></para>
+        /// <para>Created megment</para>
+        /// <para>Созданный мегмент</para>
         /// </returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         protected abstract TSegment CreateSegment(IList<T> elements, int offset, int length);
@@ -96,7 +89,7 @@ public virtual void WalkAll(IList<T> elements)
         /// <para>
         /// Iterations the segment.
         /// </para>
-        /// <para></para>
+        /// <para>Представляет базоый метод, для всех методов итерации.</para>
         /// </summary>
         /// <param name="segment">
         /// <para>The segment.</para>

csharp/Platform.Collections/Segments/Walkers/AllSegmentsWalkerBase[T].cs

@@ -6,37 +6,38 @@
 namespace Platform.Collections.Segments.Walkers
 {
     /// <summary>
-    /// <para>
-    /// Represents the all segments walker base.
-    /// </para>
-    /// <para></para>
+    /// <para>Represents the base class for walkers through all possible segments of a sequence.</para>
+    /// <para>Представляет базовый класс для проходчиков по всем возможным сегментам последовательности.</para>
     /// </summary>
     /// <seealso cref="AllSegmentsWalkerBase{T, Segment{T}}"/>
+    /// <seealso cref="AllSegmentsWalkerBase"/>
+    /// <typeparam name="T">
+    /// <para>The sequence's element type.</para>
+    /// <para>Тип элемента последовательности.</para>
+    /// </typeparam>
     public abstract class AllSegmentsWalkerBase<T> : AllSegmentsWalkerBase<T, Segment<T>>
     {
         /// <summary>
-        /// <para>
-        /// Creates the segment using the specified elements.
-        /// </para>
-        /// <para></para>
+        /// <para>Create a new instance of the <see cref="Segment{T}"/> class based on <paramref name="elements"/> sequence.</para>
+        /// <para>Создаёт новый экземпляр класса <see cref="Segment{T}"/> на основе последовательности <paramref name="elements"/>.</para>
         /// </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>
         /// </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>
         /// </returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         protected override Segment<T> CreateSegment(IList<T> elements, int offset, int length) => new Segment<T>(elements, offset, length);
     }
-}
+}