@@ -33,11 +33,17 @@ namespace Lucene.Net.Benchmarks.ByTask.Tasks
3333 /// </summary>
3434 public class TaskSequence : PerfTask
3535 {
36- // LUCENENET specific - changed from a mutable static field to a constant.
37- // While the original Java code uses a mutable static field, it is only
38- // intended to be used as a sentinel value, so we are changing it to a
39- // constant to prevent accidental modification.
40- public const int REPEAT_EXHAUST = - 2 ;
36+ /// <summary>
37+ /// A sentinel value to be used with <see cref="SetRepetitions"/> that indicates
38+ /// that it should run until exhaustion.
39+ /// </summary>
40+ /// <remarks>
41+ /// These docs are LUCENENET specific. In the original Java code, this value is
42+ /// mutable, so we are leaving this as mutable to match. Note, however, that
43+ /// mutating this during execution could result in unexpected behavior.
44+ /// </remarks>
45+ public static int REPEAT_EXHAUST = - 2 ;
46+
4147 private IList < PerfTask > tasks ;
4248 private int repetitions = 1 ;
4349 private readonly bool parallel ;
@@ -124,6 +130,7 @@ public virtual void SetRunTime(double sec)
124130 /// Sets the repetitions.
125131 /// </summary>
126132 /// <param name="repetitions">The repetitions to set.</param>
133+ /// <seealso cref="REPEAT_EXHAUST"/>
127134 public virtual void SetRepetitions ( int repetitions )
128135 {
129136 fixedTime = false ;
0 commit comments