Skip to content

Commit 0d65578

Browse files
committed
Add XML documentation for maxWidth parameter in tests
1 parent 2b8c054 commit 0d65578

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

‎test/xUnit/csharp/test_ProgressNode.cs‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ public static class ProgressNodeTests
9696
/// This test reproduces the exact scenario from the issue.
9797
/// Tests with various window widths to ensure the fix works across different terminal sizes.
9898
/// </summary>
99+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
99100
[Theory]
100101
[InlineData(20)]
101102
[InlineData(25)]
@@ -133,6 +134,7 @@ public static void ProgressBar_OriginalBugScenario_MustNotExceedMaxWidth(int max
133134
/// <summary>
134135
/// Verify that progress bar respects maxWidth for Japanese text.
135136
/// </summary>
137+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
136138
[Theory]
137139
[InlineData(20)]
138140
[InlineData(25)]
@@ -169,6 +171,7 @@ public static void ProgressBar_WithDoubleWidthChars_MustNotExceedMaxWidth(int ma
169171
/// <summary>
170172
/// Verify emoji handling with sufficient text length.
171173
/// </summary>
174+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
172175
[Theory]
173176
[InlineData(20)]
174177
[InlineData(25)]
@@ -206,6 +209,7 @@ public static void ProgressBar_WithEmoji_MustNotExceedMaxWidth(int maxWidth)
206209
/// Test various lengths of double-width text.
207210
/// All test cases have sufficient length to detect the bug.
208211
/// </summary>
212+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
209213
[Theory]
210214
[InlineData("あいうえお", 20)]
211215
[InlineData("あいうえお", 25)]
@@ -266,6 +270,7 @@ public static void ProgressBar_VariousDoubleWidthLengths_MustNotExceedMaxWidth(s
266270
/// <summary>
267271
/// Verify mixed ASCII and double-width characters.
268272
/// </summary>
273+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
269274
[Theory]
270275
[InlineData(20)]
271276
[InlineData(25)]
@@ -302,6 +307,7 @@ public static void ProgressBar_MixedWidthText_MustNotExceedMaxWidth(int maxWidth
302307
/// <summary>
303308
/// Verify long double-width string handling and truncation.
304309
/// </summary>
310+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
305311
[Theory]
306312
[InlineData(20)]
307313
[InlineData(25)]
@@ -338,6 +344,7 @@ public static void ProgressBar_LongDoubleWidthString_MustNotExceedMaxWidth(int m
338344
/// <summary>
339345
/// Verify that truncation respects character boundaries.
340346
/// </summary>
347+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
341348
[Theory]
342349
[InlineData(20)]
343350
[InlineData(25)]
@@ -376,6 +383,7 @@ public static void ProgressBar_Truncation_MustRespectCharacterBoundaries(int max
376383
/// Verifies that statusPartDisplayWidth is calculated from actual statusPart length,
377384
/// not from estimated value, to prevent progress bar from exceeding maxWidth.
378385
/// </summary>
386+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
379387
[Theory]
380388
[InlineData(20)]
381389
[InlineData(25)]
@@ -427,6 +435,7 @@ public static void ProgressBar_LongStatusWithDoubleWidth_MustNotExceedMaxWidth(i
427435
/// Test activityDisplayWidth bug with small maxWidth to amplify error.
428436
/// Bug: After truncation, activityDisplayWidth is set to maxWidth/2 but actual width differs.
429437
/// </summary>
438+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
430439
[Theory]
431440
[InlineData(20)]
432441
[InlineData(25)]
@@ -467,6 +476,7 @@ public static void ExtremeTest_ActivityWidthBug_SmallMaxWidth(int maxWidth)
467476
/// Test surrogate pair handling with strategically positioned emojis.
468477
/// Bug: Substring(i,1) splits surrogate pairs causing width calculation errors.
469478
/// </summary>
479+
/// <param name="maxWidth">The maximum width in buffer cells for the progress bar rendering.</param>
470480
[Theory]
471481
[InlineData(20)]
472482
[InlineData(25)]

0 commit comments

Comments
 (0)