Skip to content

Commit 19e2a0a

Browse files
w-ahmadw-ahmad
committed
enabled generate documentation file
1 parent 0535115 commit 19e2a0a

16 files changed

+59
-4
lines changed

‎src/ColumnFilterHandler.cs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ public ColumnFilterHandler(TableView tableView)
2020
_tableView = tableView;
2121
}
2222

23+
/// <inheritdoc/>
2324
public virtual IList<TableViewFilterItem> GetFilterItems(TableViewColumn column, string? searchText = default)
2425
{
2526
if (column is { TableView.ItemsSource: { } })
@@ -62,7 +63,7 @@ private static bool IsBlank(object? value)
6263
(value is Guid guid && guid == Guid.Empty);
6364
}
6465

65-
66+
/// <inheritdoc/>
6667
public virtual void ApplyFilter(TableViewColumn column)
6768
{
6869
if (column is { TableView: { } })
@@ -88,6 +89,7 @@ public virtual void ApplyFilter(TableViewColumn column)
8889
}
8990
}
9091

92+
/// <inheritdoc/>
9193
public virtual void ClearFilter(TableViewColumn? column)
9294
{
9395
if (column is { TableView: { } })
@@ -112,12 +114,14 @@ public virtual void ClearFilter(TableViewColumn? column)
112114
}
113115
}
114116

117+
/// <inheritdoc/>
115118
public virtual bool Filter(TableViewColumn column, object? item)
116119
{
117120
var value = column.GetCellContent(item);
118121
value = IsBlank(value) ? TableViewLocalizedStrings.BlankFilterValue : value!;
119122
return SelectedValues[column].Contains(value);
120123
}
121124

125+
/// <inheritdoc/>
122126
public IDictionary<TableViewColumn, IList<object>> SelectedValues { get; } = new Dictionary<TableViewColumn, IList<object>>();
123127
}

‎src/Columns/TableViewBoundColumn.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ public abstract class TableViewBoundColumn : TableViewColumn
1616
private Binding _binding = new();
1717
private (PropertyInfo, object?)[]? _propertyInfo;
1818

19+
/// <inheritdoc/>
1920
public override object? GetCellContent(object? dataItem)
2021
{
2122
if (dataItem is null) return null;

‎src/Columns/TableViewCheckBoxColumn.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,13 @@ public override FrameworkElement GenerateElement(TableViewCell cell, object? dat
4242
return checkBox;
4343
}
4444

45+
/// <inheritdoc/>
4546
public override FrameworkElement GenerateEditingElement(TableViewCell cell, object? dataItem)
4647
{
4748
throw new NotImplementedException();
4849
}
4950

51+
/// <inheritdoc/>
5052
public override void UpdateElementState(TableViewCell cell, object? dataItem)
5153
{
5254
if (cell?.Content is CheckBox checkBox)

‎src/Columns/TableViewTemplateColumn.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ namespace WinUI.TableView;
88
/// </summary>
99
public class TableViewTemplateColumn : TableViewColumn
1010
{
11+
/// <summary>
12+
/// Initializes a new instance of the TableViewTemplateColumn class.
13+
/// </summary>
1114
public TableViewTemplateColumn()
1215
{
1316
CanSort = false;
@@ -44,6 +47,7 @@ public override FrameworkElement GenerateEditingElement(TableViewCell cell, obje
4447
return GenerateElement(cell, dataItem);
4548
}
4649

50+
/// <inheritdoc/>
4751
public override void RefreshElement(TableViewCell cell, object? dataItem)
4852
{
4953
cell.Content = GenerateElement(cell, dataItem);

‎src/Columns/TableViewToggleSwitchColumn.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,13 @@ public override FrameworkElement GenerateElement(TableViewCell cell, object? dat
4040
return toggleSwitch;
4141
}
4242

43+
/// <inheritdoc/>
4344
public override FrameworkElement GenerateEditingElement(TableViewCell cell, object? dataItem)
4445
{
4546
throw new NotImplementedException();
4647
}
4748

49+
/// <inheritdoc/>
4850
public override void UpdateElementState(TableViewCell cell, object? dataItem)
4951
{
5052
if (cell?.Content is ToggleSwitch toggleSwitch)

‎src/Controls/TableViewTimePicker.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ public TableViewTimePicker()
3030
ClockIdentifier = _flyout.ClockIdentifier;
3131
}
3232

33+
/// <inheritdoc/>
3334
protected override void OnApplyTemplate()
3435
{
3536
base.OnApplyTemplate();
@@ -39,13 +40,15 @@ protected override void OnApplyTemplate()
3940
UpdateTimeText();
4041
}
4142

43+
/// <inheritdoc/>
4244
protected override void OnPointerPressed(PointerRoutedEventArgs e)
4345
{
4446
base.OnPointerPressed(e);
4547

4648
ShowFlyout();
4749
}
4850

51+
/// <inheritdoc/>
4952
protected override void OnKeyDown(KeyRoutedEventArgs e)
5053
{
5154
base.OnKeyDown(e);

‎src/ItemsSource/VectorChangedEventArgs.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ namespace WinUI.TableView;
55
/// <summary>
66
/// Vector changed EventArgs
77
/// </summary>
8-
/// <remarks>
98
internal partial class VectorChangedEventArgs : IVectorChangedEventArgs
109
{
10+
/// <summary>
1111
/// Initializes a new instance of the <see cref="VectorChangedEventArgs"/> class.
12-
/// </remarks>
12+
/// </summary>
1313
/// <param name="cc">collection change type</param>
1414
/// <param name="index">index of item changed</param>
1515
/// <param name="item">item changed</param>

‎src/TableView.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ private void TableView_SelectionChanged(object sender, SelectionChangedEventArgs
8585
}
8686
}
8787

88+
/// <inheritdoc/>
8889
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
8990
{
9091
base.PrepareContainerForItemOverride(element, item);
@@ -103,6 +104,8 @@ protected override void PrepareContainerForItemOverride(DependencyObject element
103104
});
104105
}
105106

107+
108+
/// <inheritdoc/>
106109
protected override DependencyObject GetContainerForItemOverride()
107110
{
108111
var row = new TableViewRow { TableView = this };
@@ -130,6 +133,7 @@ protected override DependencyObject GetContainerForItemOverride()
130133
return row;
131134
}
132135

136+
/// <inheritdoc/>
133137
protected override void OnKeyDown(KeyRoutedEventArgs e)
134138
{
135139
var shiftKey = KeyboardHelper.IsShiftKeyDown();
@@ -252,6 +256,7 @@ private bool HandleShortKeys(bool shiftKey, bool ctrlKey, VirtualKey key)
252256
return false;
253257
}
254258

259+
/// <inheritdoc/>
255260
protected async override void OnApplyTemplate()
256261
{
257262
base.OnApplyTemplate();
@@ -398,6 +403,7 @@ public string GetAllContent(bool includeHeaders, char separator = '\t')
398403
/// <summary>
399404
/// Returns specified rows' content as a string, optionally including headers, with values separated by the given character.
400405
/// </summary>
406+
/// <param name="rows">Row indexes to get content for.</param>
401407
/// <param name="includeHeaders">Whether to include headers in the output.</param>
402408
/// <param name="separator">The character used to separate cell values.</param>
403409
/// <returns>A string of specified row content separated by the specified character.</returns>
@@ -414,6 +420,7 @@ public string GetRowsContent(int[] rows, bool includeHeaders, char separator = '
414420
/// <summary>
415421
/// Returns specified cells' content as a string, optionally including headers, with values separated by the given character.
416422
/// </summary>
423+
/// <param name="slots">Cell slots to get content for.</param>
417424
/// <param name="includeHeaders">Whether to include headers in the output.</param>
418425
/// <param name="separator">The character used to separate cell values.</param>
419426
/// <returns>A string of specified cell content separated by the specified character.</returns>
@@ -1451,6 +1458,7 @@ internal void SetIsEditing(bool value)
14511458
UpdateCornerButtonState();
14521459
}
14531460

1461+
/// <inheritdoc/>
14541462
public virtual void OnSorting(TableViewSortingEventArgs eventArgs)
14551463
{
14561464
Sorting?.Invoke(this, eventArgs);

‎src/TableViewCell.cs

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public TableViewCell()
4545
}
4646

4747
#if !WINDOWS
48+
/// <inheritdoc/>
4849
protected override void OnRightTapped(RightTappedRoutedEventArgs e)
4950
{
5051
base.OnRightTapped(e);
@@ -71,6 +72,7 @@ private void OnLoaded(object sender, RoutedEventArgs e)
7172
ApplySelectionState();
7273
}
7374

75+
/// <inheritdoc/>
7476
protected override void OnApplyTemplate()
7577
{
7678
base.OnApplyTemplate();
@@ -82,6 +84,7 @@ protected override void OnApplyTemplate()
8284
EnsureGridLines();
8385
}
8486

87+
/// <inheritdoc/>
8588
protected override Size MeasureOverride(Size availableSize)
8689
{
8790
if (Column is not null && Row is not null && _contentPresenter is not null && Content is FrameworkElement element)
@@ -157,6 +160,7 @@ private double GetHorizonalGridlineHeight()
157160
return _cellPresenter?.GetHorizonalGridlineHeight() ?? 0d;
158161
}
159162

163+
/// <inheritdoc/>
160164
protected override void OnPointerEntered(PointerRoutedEventArgs e)
161165
{
162166
base.OnPointerEntered(e);
@@ -169,6 +173,7 @@ protected override void OnPointerEntered(PointerRoutedEventArgs e)
169173
}
170174
}
171175

176+
/// <inheritdoc/>
172177
protected override void OnPointerExited(PointerRoutedEventArgs e)
173178
{
174179
base.OnPointerEntered(e);
@@ -181,6 +186,7 @@ protected override void OnPointerExited(PointerRoutedEventArgs e)
181186
}
182187
}
183188

189+
/// <inheritdoc/>
184190
protected override void OnTapped(TappedRoutedEventArgs e)
185191
{
186192
base.OnTapped(e);
@@ -192,6 +198,7 @@ protected override void OnTapped(TappedRoutedEventArgs e)
192198
}
193199
}
194200

201+
/// <inheritdoc/>
195202
protected override void OnPointerPressed(PointerRoutedEventArgs e)
196203
{
197204
base.OnPointerPressed(e);
@@ -204,6 +211,7 @@ protected override void OnPointerPressed(PointerRoutedEventArgs e)
204211
}
205212
}
206213

214+
/// <inheritdoc/>
207215
protected override void OnPointerReleased(PointerRoutedEventArgs e)
208216
{
209217
base.OnPointerReleased(e);
@@ -220,6 +228,7 @@ protected override void OnPointerReleased(PointerRoutedEventArgs e)
220228
e.Handled = true;
221229
}
222230

231+
/// <inheritdoc/>
223232
protected override void OnManipulationDelta(ManipulationDeltaRoutedEventArgs e)
224233
{
225234
base.OnManipulationDelta(e);
@@ -263,6 +272,7 @@ protected override void OnManipulationDelta(ManipulationDeltaRoutedEventArgs e)
263272
return null;
264273
}
265274

275+
/// <inheritdoc/>
266276
protected override void OnDoubleTapped(DoubleTappedRoutedEventArgs e)
267277
{
268278
if (!IsReadOnly && TableView is not null && !TableView.IsEditing && !Column?.UseSingleElement is true)

‎src/TableViewCellsPresenter.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ public TableViewCellsPresenter()
2626
DefaultStyleKey = typeof(TableViewCellsPresenter);
2727
}
2828

29+
/// <inheritdoc/>
2930
protected override void OnApplyTemplate()
3031
{
3132
base.OnApplyTemplate();

0 commit comments

Comments
 (0)