Commenting Setters #38

qwasd3lol · 2021-10-31T12:32:00Z

Added russian translations of comments

There was incorrect Ru->Eng translations of "возвращает" word.

FreePhoenix888 · 2021-11-21T13:40:14Z

csharp/Platform.Setters/SetterBase.cs

@@ -11,7 +11,8 @@ namespace Platform.Setters
    /// </summary>
    /// <typeparam name="TResult"><para>The type of result value.</para><para>Тип результирующего значения.</para></typeparam>


Suggested change

/// <typeparam name="TResult"><para>The type of result value.</para><para>Тип результирующего значения.</para></typeparam>

/// <typeparam name="TResult">

/// <para>The type of a result value.</para>

/// <para>Тип результирующего значения.</para>

</typeparam>

FreePhoenix888 · 2021-11-21T13:42:19Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -42,29 +39,29 @@ public Setter(TDecision trueValue, TDecision falseValue, TResult defaultValue)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Конструктор Setter делегирует свою работу более общему, добавив ему третий параметр со значением по умолчанию.</para>


Do not say about implementation details, imagine you are reading constructor documentation and see a lot of constructors like This constructor delegates this to another, that one delegates to another one
Documentation must be autonomous

The first para must be in English, the second in Russian

FreePhoenix888 · 2021-11-21T13:45:31Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter(TDecision trueValue, TDecision falseValue) : this(trueValue, falseValue, default) { }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the Setter class using the passed-in value as the default result value.</para>


Use paramref

Suggested change

/// <para>Initializes a new instance of the Setter class using the passed-in value as the default result value.</para>

/// <para>Initializes a new instance of the Setter class with the <paramref name="defaultValue"/>.</para>

FreePhoenix888 · 2021-11-21T13:45:49Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter(TResult defaultValue) : base(defaultValue) { }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the Setter.</para>


Suggested change

/// <para>Initializes a new instance of the Setter.</para>

/// <para>Initializes a new instance of the Setter class.</para>

FreePhoenix888 · 2021-11-21T13:48:42Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter() { }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a TDecision method that sets the passed-in value as the result value and returns trueValue.</para>


Suggested change

/// <para>Initializes a TDecision method that sets the passed-in value as the result value and returns trueValue.</para>

/// <para>Assigns the <paramref name="value"/> to the result ant returns <see langword="true"/>.</para>

FreePhoenix888 · 2021-11-21T13:48:54Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -74,8 +71,8 @@ public TDecision SetAndReturnTrue(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a TDecision method that sets the passed-in value as the result value and returns falseValue.</para>


The same as above

FreePhoenix888 · 2021-11-21T13:49:09Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -85,8 +82,8 @@ public TDecision SetAndReturnFalse(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a TDecision method that sets the first passed-in from IList value as the result value and returns trueValue.</para>


The same as above

FreePhoenix888 · 2021-11-21T13:49:15Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -96,8 +93,8 @@ public TDecision SetFirstAndReturnTrue(IList<TResult> list)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a TDecision method that sets the first passed-in from IList value as the result value and returns falseValue.</para>


The same as above

csharp/Platform.Setters/Setter[TResult].cs

FreePhoenix888 · 2021-11-21T14:04:33Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// Initializes a new <see cref="Setter"/> instance.
-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new <see cref="Setter"/> instance.</para>


Above you have written Initializes a new instance of the class
Stick to the same style. Choose between this or that variant and check how microsoft does

Specify that that bool and false are used as default values for true value field and false value field

FreePhoenix888 · 2021-11-21T14:38:00Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new <see cref="Setter"/> instance.</para>
+        /// <para>Инициализирует новый экземпляр <see cref="Setter"/>.</para>


The same as above

corrections

FreePhoenix888 · 2021-11-21T16:40:03Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

+    /// <para>Тип результирующего значения.</para>
+    /// </typeparam>
+    /// <typeparam name="TDecision">
+    /// <para>The type of value which will be used to make the decision.</para>


Suggested change

/// <para>The type of value which will be used to make the decision.</para>

/// <para>The type of a value which will be used to make the decision.</para>

FreePhoenix888 · 2021-11-21T16:41:08Z

csharp/Platform.Setters/SetterBase.cs

@@ -6,10 +6,13 @@
 namespace Platform.Setters
 {
    /// <summary>
-    /// <para>Represents a base implementation for an setter that allows you to set a passed value as the result value.</para>
-    /// <para>Представляет базовую реализацию для установщика, который позволяет установить переданное ему значение в качестве результирующего значения.</para>
+    /// <para>Provides a base implementation for an setter that allows you to set a passed value as the result value.</para>


Provides a base class that allows you to set a passed value as the result value.

FreePhoenix888 · 2021-11-21T16:41:28Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-    /// <typeparam name="TResult"><para>The type of result value.</para><para>Тип результирующего значения.</para></typeparam>
-    /// <typeparam name="TDecision"><para>The type of value which will be used to make the decision.</para><para>Тип значения на основе которого будет приниматься решение.</para></typeparam>
+    /// <typeparam name="TResult">
+    /// <para>The type of result value.</para>


Add an article

FreePhoenix888 · 2021-11-21T16:41:51Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -29,7 +35,10 @@ public class Setter<TResult, TDecision> : SetterBase<TResult>
        /// <para>Initializes a new instance of the Setter class using the passed-in value as the default result value.</para>
        /// <para>Инициализирует новый экземпляр класса Setter, используя переданные значения trueValue, falseValue, defaultValue в качестве результирующего по умолчанию.</para>
        /// </summary>
-        /// <param name="defaultValue"><para>The default result value.</para><para>Результирующее значение по умолчанию.</para></param>
+        /// <param name="defaultValue">
+        /// <para>The default result value.</para>


Change the article to a

FreePhoenix888 · 2021-11-21T16:42:49Z

csharp/Platform.Setters/SetterBase.cs

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        protected SetterBase(TResult defaultValue) => _result = defaultValue;

        /// <summary>
        /// <para>Sets the passed value as the result.</para>
        /// <para>Устанавливает переданное значение в качестве результирующего.</para>
        /// </summary>
-        /// <param name="value"><para>The result value.</para><para>Результирующее значение.</para></param>
+        /// <param name="value">
+        /// <para>The result value.</para>


Change the article to a

FreePhoenix888 · 2021-11-21T16:44:18Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -39,29 +48,29 @@ public Setter(TDecision trueValue, TDecision falseValue, TResult defaultValue)
        }

        /// <summary>
-        /// <para>Конструктор Setter делегирует свою работу более общему, добавив ему третий параметр со значением по умолчанию.</para>
-        /// <para>The Setter constructor delegates its work to a more general one by adding a third parameter with a default value.</para>
+        /// <para>Initializes a new instance of the Setter class with the third parameter set as default.</para>


It is not interested for users

FreePhoenix888 · 2021-11-21T16:46:28Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// <para>Инициализирует новый экземпляр класса Setter.</para>
        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter() { }

        /// <summary>
-        /// <para>Initializes a TDecision method that sets the passed-in value as the result value and returns trueValue.</para>
-        /// <para>Инициализирует TDecision метод, устанавливающий переданное значение в качестве результирующего и возвращающий значение trueValue.</para>
+        /// <para>Assigns the <paramref name="value"/> to the result and returns <see langword="true"/>.</para>


My bad. Change true to the true value. Because a user defines its true value itself
returns true value

FreePhoenix888 · 2021-11-21T16:46:36Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -71,8 +80,8 @@ public TDecision SetAndReturnTrue(TResult value)
        }

        /// <summary>
-        /// <para>Initializes a TDecision method that sets the passed-in value as the result value and returns falseValue.</para>
-        /// <para>Инициализирует TDecision метод, устанавливающий переданное значение в качестве результирующего и возвращающий значение falseValue.</para>
+        /// <para>Assigns the <paramref name="value"/> to the result and returns <see langword="false"/>.</para>


The same as above

FreePhoenix888 · 2021-11-21T16:46:44Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -82,8 +91,8 @@ public TDecision SetAndReturnFalse(TResult value)
        }

        /// <summary>
-        /// <para>Initializes a TDecision method that sets the first passed-in from IList value as the result value and returns trueValue.</para>
-        /// <para>Инициализирует TDecision метод, устанавливающий первое переданное из IList значение в качестве результирующего и возвращающий значение trueValue.</para>
+        /// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="true"/>.</para>


The same as above

FreePhoenix888 · 2021-11-21T16:46:48Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -93,8 +102,8 @@ public TDecision SetFirstAndReturnTrue(IList<TResult> list)
        }

        /// <summary>
-        /// <para>Initializes a TDecision method that sets the first passed-in from IList value as the result value and returns falseValue.</para>
-        /// <para>Инициализирует TDecision метод, устанавливающий первое значение IList в качестве результирующего и возвращающий значение falseValue.</para>
+        /// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="false"/>.</para>


The same as above

Suggested change

/// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="false"/>.</para>

/// <para>Assigns the <paramref name="list[0]"/> to the result and returns false value.</para>

Corrected

FreePhoenix888 · 2021-11-22T17:21:29Z

csharp/Platform.Setters/SetterBase.cs

@@ -6,12 +6,16 @@
 namespace Platform.Setters
 {
    /// <summary>
-    /// <para>Represents a base implementation for an setter that allows you to set a passed value as the result value.</para>
-    /// <para>Представляет базовую реализацию для установщика, который позволяет установить переданное ему значение в качестве результирующего значения.</para>
+    /// <para>Provides a base class that allows you to set a passed value as the result value.</para>


Suggested change

/// <para>Provides a base class that allows you to set a passed value as the result value.</para>

/// <para>Provides a base class that allows to set a passed value as the result value.</para>

FreePhoenix888 · 2021-11-22T17:21:44Z

csharp/Platform.Setters/SetterBase.cs

    /// </summary>
-    /// <typeparam name="TResult"><para>The type of result value.</para><para>Тип результирующего значения.</para></typeparam>
+    /// <typeparam name="TResult">
+    /// <para>The type of result value.</para>


Suggested change

/// <para>The type of result value.</para>

/// <para>The type of a result value.</para>

FreePhoenix888 · 2021-11-22T17:23:34Z

csharp/Platform.Setters/SetterBase.cs

+        /// <param name="defaultValue">
+        /// <para>A default result value.</para>
+        /// <para>Результирующее значение по умолчанию.</para>
+        /// </param>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        protected SetterBase(TResult defaultValue) => _result = defaultValue;

        /// <summary>
        /// <para>Sets the passed value as the result.</para>


Suggested change

/// <para>Sets the passed value as the result.</para>

/// <para>Sets the <paramref name="value"/> as the result.</para>

FreePhoenix888 · 2021-11-22T17:25:36Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -42,29 +48,29 @@ public Setter(TDecision trueValue, TDecision falseValue, TResult defaultValue)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the Setter class.</para>


Suggested change

/// <para>Initializes a new instance of the Setter class.</para>

/// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class.</para>

FreePhoenix888 · 2021-11-22T17:25:47Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter(TDecision trueValue, TDecision falseValue) : this(trueValue, falseValue, default) { }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the Setter class with the <paramref name="defaultValue"/>.</para>


Suggested change

/// <para>Initializes a new instance of the Setter class with the <paramref name="defaultValue"/>.</para>

/// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/>.</para>

FreePhoenix888 · 2021-11-22T17:29:40Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -74,8 +80,8 @@ public TDecision SetAndReturnTrue(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Assigns the <paramref name="value"/> to the result and returns <see langword="false value"/>.</para>


Suggested change

/// <para>Assigns the <paramref name="value"/> to the result and returns <see langword="false value"/>.</para>

/// <para>Assigns the <paramref name="value"/> to the result and returns false value.</para>

FreePhoenix888 · 2021-11-22T17:29:51Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -85,8 +91,8 @@ public TDecision SetAndReturnFalse(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="true value"/>.</para>


Suggested change

/// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="true value"/>.</para>

/// <para>Assigns the <paramref name="list[0]"/> to the result and returns true value.</para>

FreePhoenix888 · 2021-11-22T17:30:09Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -93,8 +102,8 @@ public TDecision SetFirstAndReturnTrue(IList<TResult> list)
        }

        /// <summary>
-        /// <para>Initializes a TDecision method that sets the first passed-in from IList value as the result value and returns falseValue.</para>
-        /// <para>Инициализирует TDecision метод, устанавливающий первое значение IList в качестве результирующего и возвращающий значение falseValue.</para>
+        /// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="false"/>.</para>


Suggested change

/// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="false"/>.</para>

/// <para>Assigns the <paramref name="list[0]"/> to the result and returns false value.</para>

FreePhoenix888 · 2021-11-22T17:30:29Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// Initializes a new <see cref="Setter"/> instance.
-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the Setter class.</para>


Suggested change

/// <para>Initializes a new instance of the Setter class.</para>

/// <para>Initializes a new instance of the <see cref="Setter{TResult}"/> class.</para>

FreePhoenix888 · 2021-11-22T17:30:38Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// Initializes a new <see cref="Setter"/> instance.
-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the Setter class.</para>


Suggested change

/// <para>Initializes a new instance of the Setter class.</para>

/// <para>Initializes a new instance of the <see cref="Setter{TResult}"/> class.</para>

Corrected

corrected translation

FreePhoenix888

Methods do not return false and true boolean values. They return filed values that are set in the constructor and have TDecision Type

FreePhoenix888 · 2021-11-23T14:25:29Z

csharp/Platform.Setters/SetterBase.cs

@@ -6,47 +6,57 @@
 namespace Platform.Setters
 {
    /// <summary>
-    /// <para>Represents a base implementation for an setter that allows you to set a passed value as the result value.</para>
-    /// <para>Представляет базовую реализацию для установщика, который позволяет установить переданное ему значение в качестве результирующего значения.</para>
+    /// <para>Provides a base class that allows to set a passed value as the result value.</para>


Let us use result instead of result value :) Less words, the same meaning

csharp/Platform.Setters/SetterBase.cs

FreePhoenix888 · 2021-11-23T14:27:38Z

csharp/Platform.Setters/SetterBase.cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        protected SetterBase() { }

        /// <summary>
-        /// <para>Initializes a new instance of the SetterBase class using the passed-in value as the default result value.</para>
-        /// <para>Инициализирует новый экземпляр класса SetterBase, используя переданное значение в качестве результирующего по умолчанию.</para>
+        /// <para>Initializes a new instance of the <see cref="SetterBase{TResult}"/> class using the passed-in value as the default result value.</para>


Suggested change

/// <para>Initializes a new instance of the <see cref="SetterBase{TResult}"/> class using the passed-in value as the default result value.</para>

/// <para>Initializes a new instance of the <see cref="SetterBase"/> class using the passed-in value as the default result value.</para>

Change passed-in value to the paramref

FreePhoenix888 · 2021-11-23T14:29:30Z

csharp/Platform.Setters/SetterBase.cs

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        protected SetterBase(TResult defaultValue) => _result = defaultValue;

        /// <summary>
-        /// <para>Sets the passed value as the result.</para>
+        /// <para>Sets a <paramref name="value"/> as the result.</para>
        /// <para>Устанавливает переданное значение в качестве результирующего.</para>


Change according to the Russian version

FreePhoenix888 · 2021-11-23T14:30:03Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/>.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, со значением <paramref name="defaultValue"/> в качестве результирующего по умолчанию.</para>


Suggested change

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, со значением <paramref name="defaultValue"/> в качестве результирующего по умолчанию.</para>

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, со значением <paramref name="defaultValue"/> в качестве результата по умолчанию.</para>

FreePhoenix888 · 2021-11-23T14:30:46Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Assigns the <paramref name="value"/> to the result and returns false value.</para>
+        /// <para>Присваивает результату значение <paramref name="value"/> и возвращает <see langword="false value"/>.</para>


Suggested change

/// <para>Присваивает результату значение <paramref name="value"/> и возвращает <see langword="false value"/>.</para>

/// <para>Присваивает результату значение <paramref name="value"/> и возвращает ложь-значение.</para>

Co-authored-by: FreePhoenix888 <66206278+FreePhoenix888@users.noreply.github.com>

…into qwasd3lol

FreePhoenix888 · 2021-11-23T14:54:44Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -70,7 +70,7 @@ public Setter(TDecision trueValue, TDecision falseValue, TResult defaultValue)

        /// <summary>
        /// <para>Assigns the <paramref name="value"/> to the result and returns true value.</para>
-        /// <para>Присваивает результату значение <paramref name="value"/> и возвращает <see langword="true value"/>.</para>
+        /// <para>Присваивает результату значение <paramref name="value"/> и возвращает правда-значение.</para>


Maybe истина-значение?

FreePhoenix888 · 2021-11-23T15:10:23Z

csharp/Platform.Setters/SetterBase.cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        protected SetterBase() { }

        /// <summary>
-        /// <para>Initializes a new instance of the SetterBase class using the passed-in value as the default result value.</para>
-        /// <para>Инициализирует новый экземпляр класса SetterBase, используя переданное значение в качестве результирующего по умолчанию.</para>
+        /// <para>Initializes a new instance of the <see cref="SetterBase{TResult}"/> class using the <paramref name="defaultValue"/> as the default result.</para>


SetterBase does not have type parameters

FreePhoenix888 · 2021-11-23T15:13:26Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

+    /// <para>Тип результирующего значения.</para>
+    /// </typeparam>
+    /// <typeparam name="TDecision">
+    /// <para>The type of a value which will be used to make the decision.</para>


Suggested change

/// <para>The type of a value which will be used to make the decision.</para>

/// <para>The type of a true and false value.</para>

FreePhoenix888 · 2021-11-23T15:14:06Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter(TDecision trueValue, TDecision falseValue) : this(trueValue, falseValue, default) { }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/>.</para>


Change according to the Russian version

FreePhoenix888 · 2021-11-23T16:10:18Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -55,7 +55,7 @@ public Setter(TDecision trueValue, TDecision falseValue, TResult defaultValue)
        public Setter(TDecision trueValue, TDecision falseValue) : this(trueValue, falseValue, default) { }

        /// <summary>
-        /// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/>.</para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/> as result.</para>


Do not forget about article

Do you need an article here?

as a result

Konard · 2021-11-25T14:14:18Z

csharp/Platform.Setters/SetterBase.cs

@@ -6,47 +6,57 @@
 namespace Platform.Setters
 {
    /// <summary>
-    /// <para>Represents a base implementation for an setter that allows you to set a passed value as the result value.</para>
-    /// <para>Представляет базовую реализацию для установщика, который позволяет установить переданное ему значение в качестве результирующего значения.</para>
+    /// <para>Provides a base class that allows to set a passed value as the result.</para>


Suggested change

/// <para>Provides a base class that allows to set a passed value as the result.</para>

/// <para>Represents a base implementation for an setter that allows to set a passed value as the result.</para>

In English, the article "an" is used before vowels

Konard · 2021-11-25T14:14:46Z

csharp/Platform.Setters/SetterBase.cs

-    /// <para>Represents a base implementation for an setter that allows you to set a passed value as the result value.</para>
-    /// <para>Представляет базовую реализацию для установщика, который позволяет установить переданное ему значение в качестве результирующего значения.</para>
+    /// <para>Provides a base class that allows to set a passed value as the result.</para>
+    /// <para>Предоставляет базовый класс, который позволяет установить переданное ему значение в качестве результата.</para>


Suggested change

/// <para>Предоставляет базовый класс, который позволяет установить переданное ему значение в качестве результата.</para>

/// <para>Представляет базовую реализацию для установщика, который позволяет установить переданное ему значение в качестве результата.</para>

Konard · 2021-11-25T14:17:37Z

csharp/Platform.Setters/SetterBase.cs

-        /// <para>Initializes a new instance of the SetterBase class using the passed-in value as the default result value.</para>
-        /// <para>Инициализирует новый экземпляр класса SetterBase, используя переданное значение в качестве результирующего по умолчанию.</para>
+        /// <para>Initializes a new instance of the <see cref="SetterBase"/> class using the <paramref name="defaultValue"/> as the default result.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="SetterBase"/>, используя <paramref name="defaultValue"/> в качестве результата.</para>


Suggested change

/// <para>Инициализирует новый экземпляр класса <see cref="SetterBase"/>, используя <paramref name="defaultValue"/> в качестве результата.</para>

/// <para>Инициализирует новый экземпляр класса <see cref="SetterBase"/>, используя <paramref name="defaultValue"/> в качестве результата по умолчанию.</para>

Konard

A build fix.

csharp/Platform.Setters/Setter[TResult, TDecision].cs

Co-authored-by: Konstantin Dyachenko <konard@me.com>

Konard

Final touches.

csharp/Platform.Setters/Setter[TResult, TDecision].cs

csharp/Platform.Setters/Setter[TResult].cs

…into qwasd3lol

Konard

We are closer to merge.

Konard · 2022-02-07T18:37:13Z

csharp/Platform.Setters/SetterBase.cs

    /// <remarks>
-    /// Must be class, not struct (in order to persist access to Result property value).
+    /// <para>Must be class, not struct (in order to persist access to Result property value). <see href="https://gist.github.com/Konard/c62453978f5cca1fc48b44f74050fd80">Example</see>.</para>


Suggested change

/// <para>Must be class, not struct (in order to persist access to Result property value). <see href="https://gist.github.com/Konard/c62453978f5cca1fc48b44f74050fd80">Example</see>.</para>

/// <para>Must be class, not struct (in order to persist access to Result property value, when method is passed by reference as handler).<see href="https://gist.github.com/Konard/c62453978f5cca1fc48b44f74050fd80">Example</see>.</para>

Konard · 2022-02-07T18:47:20Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/> as a result.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, используя значение <paramref name="defaultValue"/> в качестве результата по умолчанию.</para>


Suggested change

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, используя значение <paramref name="defaultValue"/> в качестве результата по умолчанию.</para>

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, инициализируя <see cref="Result"/> значением <paramref name="defaultValue"/>.</para>

Konard · 2022-02-07T18:49:25Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter(TDecision trueValue, TDecision falseValue) : this(trueValue, falseValue, default) { }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/> as a result.</para>


Suggested change

/// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <paramref name="defaultValue"/> as a result.</para>

/// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class with the <see cref="Result"/> initialized to <paramref name="defaultValue"/>.</para>

Konard · 2022-02-07T18:50:57Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
        [MethodImpl(MethodImplOptions.AggressiveInlining)]
        public Setter() { }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="value"/> to the result and returns the value indicating true.</para>


Suggested change

/// <para>Sets the <paramref name="value"/> to the result and returns the value indicating true.</para>

/// <para>Sets the <paramref name="value"/> to the <see cref="Result"/> and returns the value indicating true.</para>

Konard · 2022-02-07T18:51:25Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="value">
+        /// <para>Result value.</para>


Suggested change

/// <para>Result value.</para>

/// <para>A result value.</para>

Konard · 2022-02-07T18:51:59Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="value"/> to the result and returns the value indicating false.</para>
+        /// <para>Устанавливает <paramref name="value"/> в качестве результата и возвращает значение означающее ложь.</para>


Suggested change

/// <para>Устанавливает <paramref name="value"/> в качестве результата и возвращает значение означающее ложь.</para>

/// <para>Устанавливает <paramref name="value"/> в качестве <see cref="Result"/> и возвращает значение означающее ложь.</para>

Konard · 2022-02-07T18:52:20Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="value">
+        /// <para>Result value.</para>


Suggested change

/// <para>Result value.</para>

/// <para>A result value.</para>

Konard · 2022-02-07T18:53:27Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="list[0]">


Suggested change

/// <param name="list[0]">

/// <param name="list">

Konard · 2022-02-07T18:54:34Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="list[0]">
+        /// <para>The first item in the list.</para>


Suggested change

/// <para>The first item in the list.</para>

/// <para>A list from which the first item will be set as <see cref="Result"/>.</para>

Konard · 2022-02-07T18:55:02Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="list[0]">


Suggested change

/// <param name="list[0]">

/// <param name="list">

Konard · 2022-02-12T20:14:59Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        public readonly TDecision TrueValue;
        public readonly TDecision FalseValue;


This readonly fields should be commented as well.

Konard · 2022-02-12T20:19:24Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="value"/> to the <see cref="Result"/> and returns the value indicating true.</para>
+        /// <para>Устанавливает <paramref name="value"/> в качестве <see cref="Result"/> и возвращает значение означающее истину.</para>


Suggested change

/// <para>Устанавливает <paramref name="value"/> в качестве <see cref="Result"/> и возвращает значение означающее истину.</para>

/// <para>Устанавливает <paramref name="value"/> в <see cref="Result"/> и возвращает значение означающее истину.</para>

Looks unclear

Suggested change

/// <para>Устанавливает <paramref name="value"/> в качестве <see cref="Result"/> и возвращает значение означающее истину.</para>

/// <para>Устанавливает <paramref name="value"/> в качестве результата и возвращает значение означающее истину.</para>

Konard · 2022-02-12T20:21:11Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="value"/> to the <see cref="Result"/> and returns the value indicating false.</para>
+        /// <para>Устанавливает <paramref name="value"/> в качестве <see cref="Result"/> и возвращает значение означающее ложь.</para>


Konard · 2022-02-12T20:21:56Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -73,9 +118,17 @@ public TDecision SetAndReturnFalse(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="list[0]"/> to the result and returns the value indicating true.</para>


Suggested change

/// <para>Sets the <paramref name="list[0]"/> to the result and returns the value indicating true.</para>

/// <para>Sets the <paramref name="list"/> to the result and returns the value indicating true.</para>

Suggested change

/// <para>Sets the <paramref name="list[0]"/> to the result and returns the value indicating true.</para>

/// <para>Sets the first <paramref name="list"/> element as the result and returns the value indicating true.</para>

@Konard , Should we use ref to the True field instead of using words the value indicating true?

Konard · 2022-02-12T20:22:16Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="list[0]"/> to the result and returns the value indicating true.</para>
+        /// <para>Устанавливает <paramref name="list[0]"/> в качестве результата и возвращает значение означающее истину.</para>


Suggested change

/// <para>Устанавливает <paramref name="list[0]"/> в качестве результата и возвращает значение означающее истину.</para>

/// <para>Устанавливает <paramref name="list"/> в качестве результата и возвращает значение означающее истину.</para>

Suggested change

/// <para>Устанавливает <paramref name="list[0]"/> в качестве результата и возвращает значение означающее истину.</para>

/// <para>Устанавливает первый элемент из <paramref name="list"/> в качестве результата и возвращает значение означающее истину.</para>

Konard

Please note, that if we to do change something in one place, it may be useful to apply such change in all similar places. This statement is true because usually we try to preserve same style across all code files in all repositories.

Konard · 2022-03-03T08:24:20Z

.gitignore

Suggested change

.DS_Store

csharp/.DS_Store

.DS_Store

No need to add to .gitignore each file in repository with the same name pattern.
Git ignore works via pattern matching. So when you write .DS_Store that means file or folder with this name in any folder.
After patterns to exclude files from repository are added to .gitignore you should delete these files. For example files:

.DS_Store csharp/.DS_Store

Should be deleted.

Konard · 2022-03-03T08:36:32Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

    public class Setter<TResult, TDecision> : SetterBase<TResult>
    {
+        /// </summary>
+        /// <param name="TrueValue">
+        /// <para>A value that indicates true.</para>


Suggested change

/// <para>A value that indicates true.</para>

/// <para>A read-only field that represents a value that indicates true.</para>

Konard · 2022-03-03T08:36:49Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

+
+        /// </summary>
+        /// <param name="FalseValue">
+        /// <para>A value that indicates false.</para>


Suggested change

/// <para>A value that indicates false.</para>

/// <para>A read-only field that represents a value that indicates false.</para>

Konard · 2022-03-03T08:37:57Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult, TDecision}"/> class using passed-in <paramref name="trueValue"/> and <paramref name="falseValue"/> as indicating true and false.</para>
+        /// <para>Иницаилизирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, используя переданные значения <paramref name="trueValue"/> и <paramref name="falseValue"/> в качестве обозначающих истину и ложь.</para>


Suggested change

/// <para>Иницаилизирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, используя переданные значения <paramref name="trueValue"/> и <paramref name="falseValue"/> в качестве обозначающих истину и ложь.</para>

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, используя переданные значения <paramref name="trueValue"/> и <paramref name="falseValue"/> в качестве обозначающих истину и ложь.</para>

Konard · 2022-03-03T09:31:34Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="value"/> to the <see cref="Result"/> and returns the value indicating true.</para>
+        /// <para>Устанавливает <paramref name="value"/> как результат и возвращает значение обозначающее истину.</para>


Suggested change

/// <para>Устанавливает <paramref name="value"/> как результат и возвращает значение обозначающее истину.</para>

/// <para>Устанавливает <paramref name="value"/> в <see cref="Result"/> и возвращает значение обозначающее истину.</para>

Konard · 2022-03-03T09:32:00Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="list"/> to the result and returns the value indicating true.</para>
+        /// <para>Устанавливает <paramref name="list"/> в качестве результата и возвращает значение означающее истину.</para>


Suggested change

/// <para>Устанавливает <paramref name="list"/> в качестве результата и возвращает значение означающее истину.</para>

/// <para>Устанавливает первый элемент из <paramref name="list"/> в <see cref="Result"/> и возвращает значение означающее истину.</para>

Konard · 2022-03-03T09:32:14Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -73,9 +129,17 @@ public TDecision SetAndReturnFalse(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="list"/> to the result and returns the value indicating true.</para>


Suggested change

/// <para>Sets the <paramref name="list"/> to the result and returns the value indicating true.</para>

/// <para>Sets the first element from <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating true.</para>

Konard · 2022-03-03T09:34:13Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="list">
+        /// <para>A list from which the first item will be set as <see cref="Result"/>.</para>
+        /// <para>Список, первый элемент которого будет установлен в качестве <see cref="Result"/>.</para>


Suggested change

/// <para>Список, первый элемент которого будет установлен в качестве <see cref="Result"/>.</para>

/// <para>Список, первый элемент которого будет установлен в <see cref="Result"/>.</para>

Konard · 2022-03-03T09:35:10Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="list"/> to the result and returns the value indicating false.</para>
+        /// <para>Устанавливает <paramref name="list"/> в качестве результата и возвращает значение означающее ложь.</para>


Suggested change

/// <para>Устанавливает <paramref name="list"/> в качестве результата и возвращает значение означающее ложь.</para>

/// <para>Устанавливает первый элемент из <paramref name="list"/> в <see cref="Result"/> и возвращает значение означающее ложь.</para>

Konard · 2022-03-03T09:37:01Z

csharp/Platform.Setters/Setter[TResult].cs

-    /// </para>
-    /// <para></para>
+    /// <para>Represents a setter that allows to set a passed value as the result. This setter variant has <typeparamref name="TDecision"/> preset to <see cref="Boolean"/>.</para>
+    /// <para>Представляет установщик, позволяющий устанавливать переданное ему значение в качестве результата. Для этого варианта установщика <typeparamref name="TDecision"/> предустановлен на <see cref="Boolean"/>.</para>


Suggested change

/// <para>Представляет установщик, позволяющий устанавливать переданное ему значение в качестве результата. Для этого варианта установщика <typeparamref name="TDecision"/> предустановлен на <see cref="Boolean"/>.</para>

/// <para>Представляет установщик, позволяющий устанавливать переданное ему значение в качестве результата. Для этого варианта установщика <typeparamref name="TDecision"/> предустановлен в <see cref="Boolean"/>.</para>

Konard

Final touches before the merge.

Konard · 2022-03-30T16:36:18Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

+        /// </summary>
+        /// <param name="TrueValue">


Suggested change

/// </summary>

/// <param name="TrueValue">

/// <summary>

This was a closing tag, here we should use an opening tag for summary.

Konard · 2022-03-30T16:36:31Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

+        /// <param name="TrueValue">
+        /// <para>A read-only field that represents a value that indicates true.</para>
+        /// <para>Поле только для чтения, представляющее значение обозначающее истину.</para>
+        /// </param>


Suggested change

/// </param>

/// </summary>

Konard · 2022-03-30T16:36:44Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

+        /// </summary>
+        /// <param name="FalseValue">


Suggested change

/// </summary>

/// <param name="FalseValue">

/// <summary>

Konard · 2022-03-30T16:36:53Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

+        /// <param name="FalseValue">
+        /// <para>A read-only field that represents a value that indicates false.</para>
+        /// <para>Поле только для чтения, представляющее значение обозначающее ложь.</para>
+        /// </param>


Suggested change

/// </param>

/// </summary>

Konard · 2022-03-30T16:45:14Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -62,9 +110,17 @@ public TDecision SetAndReturnTrue(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the first element from <paramref name="value"/> to the <see cref="Result"/> and returns the value indicating false.</para>


Suggested change

/// <para>Sets the first element from <paramref name="value"/> to the <see cref="Result"/> and returns the value indicating false.</para>

/// <para>Sets the <paramref name="value"/> to the <see cref="Result"/> and returns the value indicating false.</para>

Konard · 2022-03-30T16:50:23Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult}"/> class with the <paramref name="defaultValue"/> as a result.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult}"/> с <paramref name="defaultValue"/> в качестве результата.</para>


Suggested change

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult}"/> с <paramref name="defaultValue"/> в качестве результата.</para>

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, bool}"/> с <paramref name="defaultValue"/> в качестве результата.</para>

Konard · 2022-03-30T16:51:36Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult}"/> class with the <paramref name="defaultValue"/> as a result.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult}"/> с <paramref name="defaultValue"/> в качестве результата.</para>
        /// </summary>
        /// <param name="defaultValue">
        /// <para>A default value.</para>


Suggested change

/// <para>A default value.</para>

/// <para>A default result value.</para>

Konard · 2022-03-30T16:51:54Z

csharp/Platform.Setters/Setter[TResult].cs

        /// </summary>
        /// <param name="defaultValue">
        /// <para>A default value.</para>
-        /// <para></para>
+        /// <para>Значение по умолчанию.</para>


Suggested change

/// <para>Значение по умолчанию.</para>

/// <para>Результирующее значение по умолчанию.</para>

Konard · 2022-03-30T16:52:32Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// Initializes a new <see cref="Setter"/> instance.
-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult}"/> class.</para>


Suggested change

/// <para>Initializes a new instance of the <see cref="Setter{TResult}"/> class.</para>

/// <para>Initializes a new instance of the <see cref="Setter{TResult, bool}"/> class.</para>

Konard · 2022-03-30T16:52:40Z

csharp/Platform.Setters/Setter[TResult].cs

-        /// </para>
-        /// <para></para>
+        /// <para>Initializes a new instance of the <see cref="Setter{TResult}"/> class.</para>
+        /// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult}"/>.</para>


Suggested change

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult}"/>.</para>

/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, bool}"/>.</para>

Konard

Remove these line in all edited files:

#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member

Konard · 2022-04-27T18:50:35Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -84,9 +146,17 @@ public TDecision SetFirstAndReturnTrue(IList<TResult> list)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>


Suggested change

/// <para>Sets the <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>

/// <para> Sets the first element from <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>

csharp/Platform.Setters/Setter[TResult].cs

csharp/Platform.Setters/Setter[TResult, TDecision].cs

Konard

Few more articles should be added.

Konard · 2022-05-06T11:46:16Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -73,9 +126,17 @@ public TDecision SetAndReturnFalse(TResult value)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the first element from <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating true.</para>


Suggested change

/// <para>Sets the first element from <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating true.</para>

/// <para>Sets the first element from the <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating true.</para>

Konard · 2022-05-06T11:46:32Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="list">
+        /// <para>A list from which the first item will be set to <see cref="Result"/>.</para>


Suggested change

/// <para>A list from which the first item will be set to <see cref="Result"/>.</para>

/// <para>A list from which the first item will be set to the <see cref="Result"/>.</para>

Konard · 2022-05-06T11:47:10Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

@@ -84,9 +145,17 @@ public TDecision SetFirstAndReturnTrue(IList<TResult> list)
        }

        /// <summary>
-        /// <para>Gets result value.</para>
-        /// <para>Возвращает результирующее значение.</para>
+        /// <para>Sets the first element from<paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>


Suggested change

/// <para>Sets the first element from<paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>

/// <para>Sets the first element from the <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>

Konard · 2022-05-06T11:47:23Z

csharp/Platform.Setters/Setter[TResult, TDecision].cs

        /// </summary>
+        /// <param name="list">
+        /// <para>A list from which the first item will be set to <see cref="Result"/>.</para>


Suggested change

/// <para>A list from which the first item will be set to <see cref="Result"/>.</para>

/// <para>A list from which the first item will be set to the <see cref="Result"/>.</para>

csharp/Platform.Setters/Setter[TResult, TDecision].cs

Typo repair.

qwasd3lol added 4 commits October 31, 2021 15:28

Added comments

d91d1ad

Added russian translations of comments

Update Setter[TResult].cs

7305d0e

Update Setter[TResult, TDecision].cs

026d250

There was incorrect Ru->Eng translations of "возвращает" word.

Added comments

bf1f3ae

FreePhoenix888 requested changes Nov 21, 2021

View reviewed changes

Added comments

38212ef

corrections

FreePhoenix888 requested changes Nov 21, 2021

View reviewed changes

Added comments

00e37ea

Corrected

FreePhoenix888 requested changes Nov 22, 2021

View reviewed changes

qwasd3lol added 2 commits November 22, 2021 20:48

Added comments

41d8ad1

Corrected

Update .gitignore

470cdb8

qwasd3lol changed the title ~~Added comments~~ Commenting Setters Nov 22, 2021

Added comments

e477540

corrected translation

FreePhoenix888 requested changes Nov 23, 2021

View reviewed changes

qwasd3lol and others added 3 commits November 23, 2021 17:41

Update csharp/Platform.Setters/SetterBase.cs

8387a3e

Co-authored-by: FreePhoenix888 <66206278+FreePhoenix888@users.noreply.github.com>

Comments added

a3c6bdc

Merge branch 'qwasd3lol' of https://github.com/linksplatform/Setters …

863b25a

…into qwasd3lol

FreePhoenix888 requested changes Nov 23, 2021

View reviewed changes

Update Setter[TResult, TDecision].cs

4fa4916

FreePhoenix888 approved these changes Nov 23, 2021

View reviewed changes

FreePhoenix888 requested changes Nov 23, 2021

View reviewed changes

update

0cd5bed

FreePhoenix888 requested changes Nov 23, 2021

View reviewed changes

qwasd3lol added 3 commits November 23, 2021 19:52

Update Setter[TResult, TDecision].cs

51e3f90

Merge branch 'master' into qwasd3lol

bf9169e

Update Setter[TResult, TDecision].cs

d7db23f

Konard requested changes Nov 25, 2021

View reviewed changes

Update SetterBase.cs

60b4441

FreePhoenix888 requested a review from Konard November 25, 2021 16:12

qwasd3lol added 3 commits January 12, 2022 22:25

Merge branch 'master' into qwasd3lol

042b81d

Update Setter[TResult, TDecision].cs

4741355

update

5b5cf00

Konard requested changes Jan 13, 2022

View reviewed changes

csharp/Platform.Setters/Setter[TResult, TDecision].cs Outdated Show resolved Hide resolved

Update csharp/Platform.Setters/Setter[TResult, TDecision].cs

8658f0f

Co-authored-by: Konstantin Dyachenko <konard@me.com>

Konard requested changes Jan 17, 2022

View reviewed changes

qwasd3lol added 3 commits January 18, 2022 20:23

Added comments

f72a42d

Merge branch 'qwasd3lol' of https://github.com/linksplatform/Setters …

cbc8708

…into qwasd3lol

Update Setter[TResult, TDecision].cs

553725e

Konard requested changes Feb 7, 2022

View reviewed changes

added comments

7462dc0

Konard requested changes Feb 12, 2022

View reviewed changes

Update Setter[TResult, TDecision].cs

8accc87

Konard requested changes Mar 3, 2022

View reviewed changes

qwasd3lol added 2 commits March 3, 2022 13:11

ds store removed and comments added

3afc63b

update

3ef92d8

FreePhoenix888 changed the base branch from master to main March 27, 2022 07:14

FreePhoenix888 mentioned this pull request Mar 27, 2022

Change organization pull requests base branch from master to main linksplatform/Data.Doublets#340

Closed

Konard requested changes Mar 30, 2022

View reviewed changes

Added comments

80d961e

Konard requested changes Apr 27, 2022

View reviewed changes

csharp/Platform.Setters/Setter[TResult, TDecision].cs Show resolved Hide resolved

qwasd3lol added 2 commits May 3, 2022 13:15

added comments

6d5ea66

removed pragmas

8212c44

Konard requested changes May 6, 2022

View reviewed changes

Update Setter[TResult, TDecision].cs

6cbe27b

Konard requested changes Oct 19, 2022

View reviewed changes

csharp/Platform.Setters/Setter[TResult, TDecision].cs Outdated Show resolved Hide resolved

Update csharp/Platform.Setters/Setter[TResult, TDecision].cs

635fc9c

Typo repair.

Konard approved these changes Oct 19, 2022

View reviewed changes

Konard merged commit 55d1455 into main Oct 19, 2022

		@@ -11,7 +11,8 @@ namespace Platform.Setters
		/// </summary>
		/// <typeparam name="TResult"><para>The type of result value.</para><para>Тип результирующего значения.</para></typeparam>

	/// <para>Initializes a new instance of the Setter class using the passed-in value as the default result value.</para>
	/// <para>Initializes a new instance of the Setter class with the <paramref name="defaultValue"/>.</para>

	/// <para>Initializes a TDecision method that sets the passed-in value as the result value and returns trueValue.</para>
	/// <para>Assigns the <paramref name="value"/> to the result ant returns <see langword="true"/>.</para>

	/// <para>The type of value which will be used to make the decision.</para>
	/// <para>The type of a value which will be used to make the decision.</para>

	/// <para>Assigns the <paramref name="list[0]"/> to the result and returns <see langword="false"/>.</para>
	/// <para>Assigns the <paramref name="list[0]"/> to the result and returns false value.</para>

	/// <para>Provides a base class that allows you to set a passed value as the result value.</para>
	/// <para>Provides a base class that allows to set a passed value as the result value.</para>

	/// <para>The type of result value.</para>
	/// <para>The type of a result value.</para>

	/// <para>Sets the passed value as the result.</para>
	/// <para>Sets the <paramref name="value"/> as the result.</para>

	/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, со значением <paramref name="defaultValue"/> в качестве результирующего по умолчанию.</para>
	/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, со значением <paramref name="defaultValue"/> в качестве результата по умолчанию.</para>

	/// <para>Присваивает результату значение <paramref name="value"/> и возвращает <see langword="false value"/>.</para>
	/// <para>Присваивает результату значение <paramref name="value"/> и возвращает ложь-значение.</para>

	/// <para>The type of a value which will be used to make the decision.</para>
	/// <para>The type of a true and false value.</para>

	/// <para>Provides a base class that allows to set a passed value as the result.</para>
	/// <para>Represents a base implementation for an setter that allows to set a passed value as the result.</para>

	/// <para>Предоставляет базовый класс, который позволяет установить переданное ему значение в качестве результата.</para>
	/// <para>Представляет базовую реализацию для установщика, который позволяет установить переданное ему значение в качестве результата.</para>

	/// <para>Must be class, not struct (in order to persist access to Result property value). <see href="https://gist.github.com/Konard/c62453978f5cca1fc48b44f74050fd80">Example</see>.</para>
	/// <para>Must be class, not struct (in order to persist access to Result property value, when method is passed by reference as handler).<see href="https://gist.github.com/Konard/c62453978f5cca1fc48b44f74050fd80">Example</see>.</para>

	/// <para>Result value.</para>
	/// <para>A result value.</para>

	/// <para>Устанавливает <paramref name="value"/> в качестве результата и возвращает значение означающее ложь.</para>
	/// <para>Устанавливает <paramref name="value"/> в качестве <see cref="Result"/> и возвращает значение означающее ложь.</para>

	/// <para>The first item in the list.</para>
	/// <para>A list from which the first item will be set as <see cref="Result"/>.</para>

		public readonly TDecision TrueValue;
		public readonly TDecision FalseValue;

	/// <para>Sets the <paramref name="list[0]"/> to the result and returns the value indicating true.</para>
	/// <para>Sets the <paramref name="list"/> to the result and returns the value indicating true.</para>

	/// <para>Sets the <paramref name="list[0]"/> to the result and returns the value indicating true.</para>
	/// <para>Sets the first <paramref name="list"/> element as the result and returns the value indicating true.</para>

Commenting Setters #38

Commenting Setters #38

Conversation

qwasd3lol commented Oct 31, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FreePhoenix888 Nov 21, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FreePhoenix888 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Konard left a comment

Choose a reason for hiding this comment

Konard left a comment

Choose a reason for hiding this comment

Konard left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FreePhoenix888 Nov 21, 2021 •

edited

Loading

	/// <para>Устанавливает <paramref name="list[0]"/> в качестве результата и возвращает значение означающее истину.</para>
	/// <para>Устанавливает первый элемент из <paramref name="list"/> в качестве результата и возвращает значение означающее истину.</para>

	/// <para>A value that indicates true.</para>
	/// <para>A read-only field that represents a value that indicates true.</para>

	/// <para>A value that indicates false.</para>
	/// <para>A read-only field that represents a value that indicates false.</para>

	/// <para>Иницаилизирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, используя переданные значения <paramref name="trueValue"/> и <paramref name="falseValue"/> в качестве обозначающих истину и ложь.</para>
	/// <para>Инициализирует новый экземпляр класса <see cref="Setter{TResult, TDecision}"/>, используя переданные значения <paramref name="trueValue"/> и <paramref name="falseValue"/> в качестве обозначающих истину и ложь.</para>

	/// <para>Sets the <paramref name="list"/> to the result and returns the value indicating true.</para>
	/// <para>Sets the first element from <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating true.</para>

	/// <para>Список, первый элемент которого будет установлен в качестве <see cref="Result"/>.</para>
	/// <para>Список, первый элемент которого будет установлен в <see cref="Result"/>.</para>

	/// <para>Представляет установщик, позволяющий устанавливать переданное ему значение в качестве результата. Для этого варианта установщика <typeparamref name="TDecision"/> предустановлен на <see cref="Boolean"/>.</para>
	/// <para>Представляет установщик, позволяющий устанавливать переданное ему значение в качестве результата. Для этого варианта установщика <typeparamref name="TDecision"/> предустановлен в <see cref="Boolean"/>.</para>

	/// <para>A default value.</para>
	/// <para>A default result value.</para>

	/// <para>Значение по умолчанию.</para>
	/// <para>Результирующее значение по умолчанию.</para>

	/// <para>Sets the <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>
	/// <para> Sets the first element from <paramref name="list"/> to the <see cref="Result"/> and returns the value indicating false.</para>