Added missing code comments. ThreadHelpers.ExtendedMaxStackSize renamed to DefaultExtendedMaxStackSize. ThreadHelpers.DefaultSleepTimeout renamed to DefaultSleepInterval. ThreadHelpers.SyncInvokeWithExtendedStack renamed to InvokeWithModifiedMaxStackSize and InvokeWithExtendedMaxStackSize methods.

konard · konard · commit 38c6edb018ac · 2019-09-01T15:11:18.000+03:00
diff --git a/ConcurrentQueueExtensions.cs b/ConcurrentQueueExtensions.cs
@@ -3,12 +3,20 @@
 using System.Threading.Tasks;
 using Platform.Collections.Concurrent;
 
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
-
 namespace Platform.Threading
 {
+    /// <summary>
+    /// <para>Provides a set of extension methods for <see cref="ConcurrentQueue{T}"/> objects.</para>
+    /// <para>Предоставляет набор методов расширения для объектов <see cref="ConcurrentQueue{T}"/>.</para>
+    /// </summary>
     public static class ConcurrentQueueExtensions
     {
+        /// <summary>
+        /// <para>Suspends evaluation of the method until all asynchronous operations in the queue finish.</para>
+        /// <para>Приостановляет выполнение метода до завершения всех асинхронных операций в очереди.</para>
+        /// </summary>
+        /// <param name="queue"><para>The queue of asynchronous operations.</para><para>Очередь асинхронных операций.</para></param>
+        /// <returns><para>An asynchronous operation representation.</para><para>Представление асинхронной операции.</para></returns>
         public static async Task AwaitAll(this ConcurrentQueue<Task> queue)
         {
             foreach (var item in queue.DequeueAll())
@@ -17,6 +25,12 @@ public static async Task AwaitAll(this ConcurrentQueue<Task> queue)
             }
         }
 
+        /// <summary>
+        /// <para>Suspends evaluation of the method until the first asynchronous operation in the queue finishes.</para>
+        /// <para>Приостанавливает выполнение метода до завершения первой асинхронной операции в очереди.</para>
+        /// </summary>
+        /// <param name="queue"><para>The queue of asynchronous operations.</para><para>Очередь асинхронных операций.</para></param>
+        /// <returns><para>An asynchronous operation representation.</para><para>Представление асинхронной операции.</para></returns>
         public static async Task AwaitOne(this ConcurrentQueue<Task> queue)
         {
             if (queue.TryDequeue(out Task item))
@@ -25,6 +39,12 @@ public static async Task AwaitOne(this ConcurrentQueue<Task> queue)
             }
         }
 
+        /// <summary>
+        /// <para>Adds an <see cref="Action"/> as runned <see cref="Task"/> to the end of the <see cref="ConcurrentQueue{T}"/>.</para>
+        /// <para>Добавляет <see cref="Action"/> как запущенную <see cref="Task"/> в конец <see cref="ConcurrentQueue{T}"/>.</para>
+        /// </summary>
+        /// <param name="queue"><para>The queue of asynchronous operations.</para><para>Очередь асинхронных операций.</para></param>
+        /// <param name="action"><para>The <see cref="Action"/> delegate.</para><para>Делагат <see cref="Action"/>.</para></param>
         public static void EnqueueAsRunnedTask(this ConcurrentQueue<Task> queue, Action action) => queue.Enqueue(Task.Run(action));
     }
 }
diff --git a/TaskExtensions.cs b/TaskExtensions.cs
@@ -1,11 +1,20 @@
 ﻿using System.Threading.Tasks;
 
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
-
 namespace Platform.Threading
 {
+    /// <summary>
+    /// <para>Provides a set of extension methods for <see cref="Task{TReturn}"/> objects.</para>
+    /// <para>Предоставляет набор методов расширения для объектов <see cref="Task{TReturn}"/>.</para>
+    /// </summary>
     public static class TaskExtensions
     {
-        public static T AwaitResult<T>(this Task<T> task) => task.GetAwaiter().GetResult();
+        /// <summary>
+        /// <para>Waits for completion of the asynchronous <see cref="Task{TReturn}"/> and returns its result.</para>
+        /// <para>Ожидает завершения асинхронной <see cref="Task{TReturn}"/> и возвращает её результат.</para>
+        /// </summary>
+        /// <typeparam name="TReturn"><para>The return value type.</para><para>Тип возвращаемого значения.</para></typeparam>
+        /// <param name="task"><para>The asynchronous <see cref="Task{TReturn}"/>.</para><para>Ассинхронная <see cref="Task{TReturn}"/>.</para></param>
+        /// <returns><para>The result of completed <see cref="Task{TReturn}"/>.</para><para>Результат завершённой <see cref="Task{TReturn}"/>.</para></returns>
+        public static TReturn AwaitResult<TReturn>(this Task<TReturn> task) => task.GetAwaiter().GetResult();
     }
 }
diff --git a/ThreadHelpers.cs b/ThreadHelpers.cs
@@ -1,42 +1,117 @@
 ﻿using System;
 using System.Threading;
 
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
-
 namespace Platform.Threading
 {
+    /// <summary>
+    /// <para>Provides a set of helper methods for <see cref="Thread"/> objects.</para>
+    /// <para>Предоставляет набор вспомогательных методов для объектов <see cref="Thread"/>.</para>
+    /// </summary>
     public static class ThreadHelpers
     {
+        /// <summary>
+        /// <para>Gets the maximum stack size in bytes by default.</para>
+        /// <para>Возвращает размер максимальный стека в байтах по умолчанию.</para>
+        /// </summary>
         public static readonly int DefaultMaxStackSize;
-        public static readonly int ExtendedMaxStackSize = 200 * 1024 * 1024;
-        public static readonly int DefaultSleepTimeout = 1;
 
-        public static void SyncInvokeWithExtendedStack<T>(T param, Action<object> action) => SyncInvokeWithExtendedStack(param, action, ExtendedMaxStackSize);
+        /// <summary>
+        /// <para>Gets the extended maximum stack size in bytes by default.</para>
+        /// <para>Возвращает расширенный максимальный размер стека в байтах по умолчанию.</para>
+        /// </summary>
+        public static readonly int DefaultExtendedMaxStackSize = 200 * 1024 * 1024;
 
-        public static void SyncInvokeWithExtendedStack<T>(T param, Action<object> action, int maxStackSize) => StartNew(param, action, maxStackSize).Join();
+        /// <summary>
+        /// <para>Returns the default time interval for transferring control to other threads in milliseconds</para>
+        /// <para>Возвращает интервал времени для передачи управления другим потокам в миллисекундах по умолчанию.</para>
+        /// </summary>
+        public static readonly int DefaultSleepInterval = 1;
 
-        public static void SyncInvokeWithExtendedStack(Action action) => SyncInvokeWithExtendedStack(action, ExtendedMaxStackSize);
+        /// <summary>
+        /// <para>Invokes the <see cref="Action{T}"/> with modified maximum stack size.</para>
+        /// <para>Вызывает <see cref="Action{T}"/> с изменённым максимальным размером стека.</para>
+        /// </summary>
+        /// <typeparam name="T"><para>The type of the <see cref="Action{T}"/> argument.</para><para>Тип аргумента <see cref="Action{T}"/>.</para></typeparam>
+        /// <param name="param"><para>The object containing data to be used by the invoked <see cref="Action{T}"/> delegate.</para><para>Объект, содержащий данные, которые будут использоваться вызваемым делегатом <see cref="Action{T}"/>.</para></param>
+        /// <param name="action"><para>The <see cref="Action{T}"/> delegate.</para><para>Делагат <see cref="Action{T}"/>.</para></param>
+        /// <param name="maxStackSize"><para>The maximum stack size in bytes.</para><para>Максимальный размер стека в байтах.</para></param>
+        public static void InvokeWithModifiedMaxStackSize<T>(T param, Action<object> action, int maxStackSize) => StartNew(param, action, maxStackSize).Join();
 
-        public static void SyncInvokeWithExtendedStack(Action action, int maxStackSize) => StartNew(action, maxStackSize).Join();
+        /// <summary>
+        /// <para>Invokes the <see cref="Action{T}"/> with extend maximum stack size.</para>
+        /// <para>Вызывает <see cref="Action{T}"/> с расширенным максимальным размером стека.</para>
+        /// </summary>
+        /// <typeparam name="T"><para>The type of the <see cref="Action{T}"/> argument.</para><para>Тип аргумента <see cref="Action{T}"/>.</para></typeparam>
+        /// <param name="param"><para>The object containing data to be used by the invoked <see cref="Action{T}"/> delegate.</para><para>Объект, содержащий данные, которые будут использоваться вызваемым делегатом <see cref="Action{T}"/>.</para></param>
+        /// <param name="action"><para>The <see cref="Action{T}"/> delegate.</para><para>Делагат <see cref="Action{T}"/>.</para></param>
+        public static void InvokeWithExtendedMaxStackSize<T>(T param, Action<object> action) => InvokeWithModifiedMaxStackSize(param, action, DefaultExtendedMaxStackSize);
 
-        public static Thread StartNew<T>(T param, Action<object> action) => StartNew(param, action, DefaultMaxStackSize);
+        /// <summary>
+        /// <para>Invokes the <see cref="Action"/> with modified maximum stack size.</para>
+        /// <para>Вызывает <see cref="Action"/> с изменённым максимальным размером стека.</para>
+        /// </summary>
+        /// <param name="action"><para>The <see cref="Action"/> delegate.</para><para>Делагат <see cref="Action"/>.</para></param>
+        /// <param name="maxStackSize"><para>The maximum stack size in bytes.</para><para>Максимальный размер стека в байтах.</para></param>
+        public static void InvokeWithModifiedMaxStackSize(Action action, int maxStackSize) => StartNew(action, maxStackSize).Join();
 
+        /// <summary>
+        /// <para>Invokes the <see cref="Action"/> with extend maximum stack size.</para>
+        /// <para>Вызывает <see cref="Action"/> с расширенным максимальным размером стека.</para>
+        /// </summary>
+        /// <param name="action"><para>The <see cref="Action"/> delegate.</para><para>Делагат <see cref="Action"/>.</para></param>
+        public static void InvokeWithExtendedMaxStackSize(Action action) => InvokeWithModifiedMaxStackSize(action, DefaultExtendedMaxStackSize);
+
+        /// <summary>
+        /// <para>Initializes a new instance of the <see cref="Thread"/> class, causes the operating system to change the state of that instance to <see cref="ThreadState.Running"/> and supplies an object containing data to be used by the method that thread executes.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Thread"/>, просит операционную систему изменить состояние этого экземпляра на <see cref="ThreadState.Running"/> и предоставляет объект, содержащий данные, которые будут использоваться в методе, который выполняет этот поток.</para>
+        /// </summary>
+        /// <typeparam name="T"><para>The type of the <see cref="Action{T}"/> argument.</para><para>Тип аргумента <see cref="Action{T}"/>.</para></typeparam>
+        /// <param name="param"><para>The object containing data to be used by the method that thread executes.</para><para>Объект, содержащий данные, которые будут использоваться методом, выполняемым потоком.</para></param>
+        /// <param name="action"><para>The <see cref="Action{T}"/> delegate.</para><para>Делагат <see cref="Action{T}"/>.</para></param>
+        /// <param name="maxStackSize"><para>The maximum stack size in bytes.</para><para>Максимальный размер стека в байтах.</para></param>
+        /// <returns><para>A new started <see cref="Thread"/> instance.</para><para>Новый запущенный экземпляр <see cref="Thread"/>.</para></returns>
         public static Thread StartNew<T>(T param, Action<object> action, int maxStackSize)
         {
             var thread = new Thread(new ParameterizedThreadStart(action), maxStackSize);
             thread.Start(param);
             return thread;
         }
 
-        public static Thread StartNew(Action action) => StartNew(action, DefaultMaxStackSize);
+        /// <summary>
+        /// <para>Initializes a new instance of the <see cref="Thread"/> class, causes the operating system to change the state of that instance to <see cref="ThreadState.Running"/> and supplies an object containing data to be used by the method that thread executes.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Thread"/>, просит операционную систему изменить состояние этого экземпляра на <see cref="ThreadState.Running"/> и предоставляет объект, содержащий данные, которые будут использоваться в методе, который выполняет этот поток.</para>
+        /// </summary>
+        /// <typeparam name="T"><para>The type of the <see cref="Action{T}"/> argument.</para><para>Тип аргумента <see cref="Action{T}"/>.</para></typeparam>
+        /// <param name="param"><para>The object containing data to be used by the method that thread executes.</para><para>Объект, содержащий данные, которые будут использоваться методом, выполняемым потоком.</para></param>
+        /// <param name="action"><para>The <see cref="Action{T}"/> delegate.</para><para>Делагат <see cref="Action{T}"/>.</para></param>
+        /// <returns><para>A new started <see cref="Thread"/> instance.</para><para>Новый запущенный экземпляр <see cref="Thread"/>.</para></returns>
+        public static Thread StartNew<T>(T param, Action<object> action) => StartNew(param, action, DefaultMaxStackSize);
 
+        /// <summary>
+        /// <para>Initializes a new instance of the <see cref="Thread"/> class, causes the operating system to change the state of that instance to <see cref="ThreadState.Running"/> and supplies the method executed by that thread.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Thread"/>, просит операционную систему изменить состояние этого экземпляра на <see cref="ThreadState.Running"/> и предоставляет метод, который выполняется этим потоком.</para>
+        /// </summary>
+        /// <param name="action"><para>The <see cref="Action"/> delegate.</para><para>Делагат <see cref="Action"/>.</para></param>
+        /// <param name="maxStackSize"><para>The maximum stack size in bytes.</para><para>Максимальный размер стека в байтах.</para></param>
+        /// <returns><para>A new started <see cref="Thread"/> instance.</para><para>Новый запущенный экземпляр <see cref="Thread"/>.</para></returns>
         public static Thread StartNew(Action action, int maxStackSize)
         {
             var thread = new Thread(new ThreadStart(action), maxStackSize);
             thread.Start();
             return thread;
         }
 
-        public static void Sleep() => Thread.Sleep(DefaultSleepTimeout);
+        /// <summary>
+        /// <para>Initializes a new instance of the <see cref="Thread"/> class, causes the operating system to change the state of that instance to <see cref="ThreadState.Running"/> and supplies the method executed by that thread.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Thread"/>, просит операционную систему изменить состояние этого экземпляра на <see cref="ThreadState.Running"/> и предоставляет метод, который выполняется этим потоком.</para>
+        /// </summary>
+        /// <param name="action"><para>The <see cref="Action"/> delegate.</para><para>Делагат <see cref="Action"/>.</para></param>
+        /// <returns><para>A new started <see cref="Thread"/> instance.</para><para>Новый запущенный экземпляр <see cref="Thread"/>.</para></returns>
+        public static Thread StartNew(Action action) => StartNew(action, DefaultMaxStackSize);
+
+        /// <summary>
+        /// Suspends the current thread for the <see cref="DefaultSleepInterval"/>.
+        /// </summary>
+        public static void Sleep() => Thread.Sleep(DefaultSleepInterval);
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,20 @@`
`3`	`3`	`using System.Threading.Tasks;`
`4`	`4`	`using Platform.Collections.Concurrent;`
`5`	`5`
`6`		`-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member`
`7`		`-`
`8`	`6`	`namespace Platform.Threading`
`9`	`7`	`{`
	`8`	`+ /// <summary>`
	`9`	`+ /// <para>Provides a set of extension methods for <see cref="ConcurrentQueue{T}"/> objects.</para>`
	`10`	`+ /// <para>Предоставляет набор методов расширения для объектов <see cref="ConcurrentQueue{T}"/>.</para>`
	`11`	`+ /// </summary>`
`10`	`12`	`public static class ConcurrentQueueExtensions`
`11`	`13`	`{`
	`14`	`+ /// <summary>`
	`15`	`+ /// <para>Suspends evaluation of the method until all asynchronous operations in the queue finish.</para>`
	`16`	`+ /// <para>Приостановляет выполнение метода до завершения всех асинхронных операций в очереди.</para>`
	`17`	`+ /// </summary>`
	`18`	`+ /// <param name="queue"><para>The queue of asynchronous operations.</para><para>Очередь асинхронных операций.</para></param>`
	`19`	`+ /// <returns><para>An asynchronous operation representation.</para><para>Представление асинхронной операции.</para></returns>`
`12`	`20`	`public static async Task AwaitAll(this ConcurrentQueue<Task> queue)`
`13`	`21`	`{`
`14`	`22`	`foreach (var item in queue.DequeueAll())`
`@@ -17,6 +25,12 @@ public static async Task AwaitAll(this ConcurrentQueue<Task> queue)`
`17`	`25`	`}`
`18`	`26`	`}`
`19`	`27`
	`28`	`+ /// <summary>`
	`29`	`+ /// <para>Suspends evaluation of the method until the first asynchronous operation in the queue finishes.</para>`
	`30`	`+ /// <para>Приостанавливает выполнение метода до завершения первой асинхронной операции в очереди.</para>`
	`31`	`+ /// </summary>`
	`32`	`+ /// <param name="queue"><para>The queue of asynchronous operations.</para><para>Очередь асинхронных операций.</para></param>`
	`33`	`+ /// <returns><para>An asynchronous operation representation.</para><para>Представление асинхронной операции.</para></returns>`
`20`	`34`	`public static async Task AwaitOne(this ConcurrentQueue<Task> queue)`
`21`	`35`	`{`
`22`	`36`	`if (queue.TryDequeue(out Task item))`
`@@ -25,6 +39,12 @@ public static async Task AwaitOne(this ConcurrentQueue<Task> queue)`
`25`	`39`	`}`
`26`	`40`	`}`
`27`	`41`
	`42`	`+ /// <summary>`
	`43`	`+ /// <para>Adds an <see cref="Action"/> as runned <see cref="Task"/> to the end of the <see cref="ConcurrentQueue{T}"/>.</para>`
	`44`	`+ /// <para>Добавляет <see cref="Action"/> как запущенную <see cref="Task"/> в конец <see cref="ConcurrentQueue{T}"/>.</para>`
	`45`	`+ /// </summary>`
	`46`	`+ /// <param name="queue"><para>The queue of asynchronous operations.</para><para>Очередь асинхронных операций.</para></param>`
	`47`	`+ /// <param name="action"><para>The <see cref="Action"/> delegate.</para><para>Делагат <see cref="Action"/>.</para></param>`
`28`	`48`	`public static void EnqueueAsRunnedTask(this ConcurrentQueue<Task> queue, Action action) => queue.Enqueue(Task.Run(action));`
`29`	`49`	`}`
`30`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,20 @@`
`1`	`1`	`using System.Threading.Tasks;`
`2`	`2`
`3`		`-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member`
`4`		`-`
`5`	`3`	`namespace Platform.Threading`
`6`	`4`	`{`
	`5`	`+ /// <summary>`
	`6`	`+ /// <para>Provides a set of extension methods for <see cref="Task{TReturn}"/> objects.</para>`
	`7`	`+ /// <para>Предоставляет набор методов расширения для объектов <see cref="Task{TReturn}"/>.</para>`
	`8`	`+ /// </summary>`
`7`	`9`	`public static class TaskExtensions`
`8`	`10`	`{`
`9`		`- public static T AwaitResult<T>(this Task<T> task) => task.GetAwaiter().GetResult();`
	`11`	`+ /// <summary>`
	`12`	`+ /// <para>Waits for completion of the asynchronous <see cref="Task{TReturn}"/> and returns its result.</para>`
	`13`	`+ /// <para>Ожидает завершения асинхронной <see cref="Task{TReturn}"/> и возвращает её результат.</para>`
	`14`	`+ /// </summary>`
	`15`	`+ /// <typeparam name="TReturn"><para>The return value type.</para><para>Тип возвращаемого значения.</para></typeparam>`
	`16`	`+ /// <param name="task"><para>The asynchronous <see cref="Task{TReturn}"/>.</para><para>Ассинхронная <see cref="Task{TReturn}"/>.</para></param>`
	`17`	`+ /// <returns><para>The result of completed <see cref="Task{TReturn}"/>.</para><para>Результат завершённой <see cref="Task{TReturn}"/>.</para></returns>`
	`18`	`+ public static TReturn AwaitResult<TReturn>(this Task<TReturn> task) => task.GetAwaiter().GetResult();`
`10`	`19`	`}`
`11`	`20`	`}`