Skip to content

Commit 1649c4c

Browse files
committed
Fix all CS1591 XML documentation warnings
Added /// <inheritdoc/> comments to ActualX, ActualY, ActualWidth, and ActualHeight properties in 8 control classes: - ButtonControl - CheckboxControl - DropdownControl (both main class and DropdownPortalContent) - ListControl - MenuControl (including MenuItem class) - MultilineEditControl - PromptControl - TreeControl These properties implement IWindowControl interface which already has full XML documentation. Using inheritdoc avoids duplication and ensures documentation stays synchronized with the interface. Build now succeeds with 0 warnings.
1 parent 46f092f commit 1649c4c

8 files changed

Lines changed: 40 additions & 0 deletions

File tree

SharpConsoleUI/Controls/ButtonControl.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,13 @@ public ButtonControl()
5151
/// </summary>
5252
public int? ContentWidth => GetButtonWidth() + _margin.Left + _margin.Right;
5353

54+
/// <inheritdoc/>
5455
public int ActualX => _actualX;
56+
/// <inheritdoc/>
5557
public int ActualY => _actualY;
58+
/// <inheritdoc/>
5659
public int ActualWidth => _actualWidth;
60+
/// <inheritdoc/>
5761
public int ActualHeight => _actualHeight;
5862

5963
private int GetButtonWidth()

SharpConsoleUI/Controls/CheckboxControl.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,13 @@ public CheckboxControl(string label = "Checkbox", bool isChecked = false)
101101
/// </summary>
102102
public int? ContentWidth => GetCheckboxWidth() + _margin.Left + _margin.Right;
103103

104+
/// <inheritdoc/>
104105
public int ActualX => _actualX;
106+
/// <inheritdoc/>
105107
public int ActualY => _actualY;
108+
/// <inheritdoc/>
106109
public int ActualWidth => _actualWidth;
110+
/// <inheritdoc/>
107111
public int ActualHeight => _actualHeight;
108112

109113
private int GetCheckboxWidth()

SharpConsoleUI/Controls/DropdownControl.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,9 +221,13 @@ public int? ContentWidth
221221
}
222222
}
223223

224+
/// <inheritdoc/>
224225
public int ActualX => _actualX;
226+
/// <inheritdoc/>
225227
public int ActualY => _actualY;
228+
/// <inheritdoc/>
226229
public int ActualWidth => _actualWidth;
230+
/// <inheritdoc/>
227231
public int ActualHeight => _actualHeight;
228232

229233
/// <inheritdoc/>
@@ -1808,9 +1812,13 @@ public bool ProcessMouseEvent(MouseEventArgs args)
18081812
public int? ContentWidth => _owner.GetPortalBounds().Width;
18091813
public int? ContentHeight => _owner.GetPortalBounds().Height;
18101814

1815+
/// <inheritdoc/>
18111816
public int ActualX => _actualX;
1817+
/// <inheritdoc/>
18121818
public int ActualY => _actualY;
1819+
/// <inheritdoc/>
18131820
public int ActualWidth => _actualWidth;
1821+
/// <inheritdoc/>
18141822
public int ActualHeight => _actualHeight;
18151823

18161824
public HorizontalAlignment HorizontalAlignment { get; set; } = HorizontalAlignment.Left;

SharpConsoleUI/Controls/ListControl.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -393,9 +393,13 @@ public int? ContentWidth
393393
}
394394
}
395395

396+
/// <inheritdoc/>
396397
public int ActualX => _actualX;
398+
/// <inheritdoc/>
397399
public int ActualY => _actualY;
400+
/// <inheritdoc/>
398401
public int ActualWidth => _actualWidth;
402+
/// <inheritdoc/>
399403
public int ActualHeight => _actualHeight;
400404

401405
/// <inheritdoc/>

SharpConsoleUI/Controls/MenuControl.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,9 +295,13 @@ public int? Width
295295
/// <inheritdoc/>
296296
public int? ContentWidth => null;
297297

298+
/// <inheritdoc/>
298299
public int ActualX => _actualX;
300+
/// <inheritdoc/>
299301
public int ActualY => _actualY;
302+
/// <inheritdoc/>
300303
public int ActualWidth => _actualWidth;
304+
/// <inheritdoc/>
301305
public int ActualHeight => _actualHeight;
302306

303307
/// <inheritdoc/>
@@ -2309,9 +2313,13 @@ public bool ProcessMouseEvent(MouseEventArgs args)
23092313
// IWindowControl minimal implementation
23102314
public int? ContentWidth => _dropdown.Bounds.Width;
23112315
public int? ContentHeight => _dropdown.Bounds.Height;
2316+
/// <inheritdoc/>
23122317
public int ActualX => _actualX;
2318+
/// <inheritdoc/>
23132319
public int ActualY => _actualY;
2320+
/// <inheritdoc/>
23142321
public int ActualWidth => _actualWidth;
2322+
/// <inheritdoc/>
23152323
public int ActualHeight => _actualHeight;
23162324
public HorizontalAlignment HorizontalAlignment { get; set; } = HorizontalAlignment.Left;
23172325
public VerticalAlignment VerticalAlignment { get; set; } = VerticalAlignment.Top;

SharpConsoleUI/Controls/MultilineEditControl.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,13 @@ public int? ContentWidth
156156
}
157157
}
158158

159+
/// <inheritdoc/>
159160
public int ActualX => _actualX;
161+
/// <inheritdoc/>
160162
public int ActualY => _actualY;
163+
/// <inheritdoc/>
161164
public int ActualWidth => _actualWidth;
165+
/// <inheritdoc/>
162166
public int ActualHeight => _actualHeight;
163167

164168
/// <summary>

SharpConsoleUI/Controls/PromptControl.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,13 @@ public int? ContentWidth
7979
}
8080
}
8181

82+
/// <inheritdoc/>
8283
public int ActualX => _actualX;
84+
/// <inheritdoc/>
8385
public int ActualY => _actualY;
86+
/// <inheritdoc/>
8487
public int ActualWidth => _actualWidth;
88+
/// <inheritdoc/>
8589
public int ActualHeight => _actualHeight;
8690

8791
/// <inheritdoc/>

SharpConsoleUI/Controls/TreeControl.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,13 @@ public int? ContentWidth
9696
}
9797
}
9898

99+
/// <inheritdoc/>
99100
public int ActualX => _actualX;
101+
/// <inheritdoc/>
100102
public int ActualY => _actualY;
103+
/// <inheritdoc/>
101104
public int ActualWidth => _actualWidth;
105+
/// <inheritdoc/>
102106
public int ActualHeight => _actualHeight;
103107

104108
/// <inheritdoc/>

0 commit comments

Comments
 (0)