Skip to content

Commit

Permalink
Fix some documentation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
tom-englert committed Sep 6, 2020
1 parent ef472d8 commit 8411ea4
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace DataGridExtensions
namespace DataGridExtensions.Behaviors
{
using System;
using System.Collections.Generic;
Expand Down Expand Up @@ -58,7 +58,7 @@ private void SortDescriptions_CollectionChanged(object? sender, NotifyCollection
PersistLastKnownSortDescriptions();
}

private void ItemsSource_Changed(object sender, EventArgs e)
private void ItemsSource_Changed(object? sender, EventArgs e)
{
try
{
Expand Down
12 changes: 8 additions & 4 deletions src/DataGridExtensions/DataGridFilter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ public static class DataGridFilter
/// <summary>
/// Gets if the default filters are automatically attached to each column.
/// </summary>
/// <param name="dataGrid">The data grid.</param>
/// <returns><c>true</c> is auto-filtering is enabled.</returns>
[AttachedPropertyBrowsableForType(typeof(DataGrid))]
public static bool GetIsAutoFilterEnabled(this DataGrid dataGrid)
{
Expand Down Expand Up @@ -47,6 +49,8 @@ private static void IsAutoFilterEnabled_Changed(DependencyObject sender, Depende
/// Filter attached property to attach the DataGridFilterHost instance to the owning DataGrid.
/// This property is only used by code and is not accessible from XAML.
/// </summary>
/// <param name="dataGrid">The data grid.</param>
/// <returns></returns>
public static DataGridFilterHost GetFilter(this DataGrid dataGrid)
{
var value = (DataGridFilterHost)dataGrid.GetValue(FilterProperty);
Expand Down Expand Up @@ -163,17 +167,17 @@ public static void SetResourceLocator(this DataGrid dataGrid, IResourceLocator?


/// <summary>
/// Gets the value of the <see cref="P:DataGridExtensions.GlobalFilter"/> attached property from a given <see cref="DataGrid"/>.
/// Gets the value of the <see cref="P:DataGridExtensions.DataGridFilter.GlobalFilter"/> attached property from a given <see cref="DataGrid"/>.
/// </summary>
/// <param name="dataGrid">The <see cref="DataGrid"/> from which to read the property value.</param>
/// <returns>the value of the <see cref="P:DataGridExtensions.GlobalFilter"/> attached property.</returns>
/// <returns>the value of the <see cref="P:DataGridExtensions.DataGridFilter.GlobalFilter"/> attached property.</returns>
[AttachedPropertyBrowsableForType(typeof(DataGrid))]
public static Predicate<object?>? GetGlobalFilter(DataGrid dataGrid)
{
return (Predicate<object?>?)dataGrid.GetValue(GlobalFilterProperty);
}
/// <summary>
/// Sets the value of the <see cref="P:DataGridExtensions.GlobalFilter" /> attached property to a given <see cref="DataGrid" />.
/// Sets the value of the <see cref="P:DataGridExtensions.DataGridFilter.GlobalFilter" /> attached property to a given <see cref="DataGrid" />.
/// </summary>
/// <param name="dataGrid">The <see cref="DataGrid" /> on which to set the property value.</param>
/// <param name="value">The property value to set.</param>
Expand All @@ -182,7 +186,7 @@ public static void SetGlobalFilter(DataGrid dataGrid, Predicate<object?>? value)
dataGrid.SetValue(GlobalFilterProperty, value);
}
/// <summary>
/// Identifies the <see cref="P:DataGridExtensions.GlobalFilter"/> dependency property.
/// Identifies the <see cref="P:DataGridExtensions.DataGridFilter.GlobalFilter"/> dependency property.
/// </summary>
/// <AttachedPropertyComments>
/// <summary>
Expand Down
3 changes: 1 addition & 2 deletions src/DataGridExtensions/DataGridFilteringEventArgs.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,14 @@

/// <summary>
/// Notification about additional columns to be filtered.
/// Clients can e.g. use this event to cache/preload column data in a different thread and/or display a wait cursor while filtering.
/// Clients can e.g. use this event to cache/pre-load column data in a different thread and/or display a wait cursor while filtering.
/// <remarks>
/// Clients may only cancel the processing when e.g. the data grid is about to be unloaded. Canceling the process of filtering
/// will cause the UI to be inconsistent.
/// </remarks>
/// </summary>
public class DataGridFilteringEventArgs : CancelEventArgs
{
/// <inheritdoc />
/// <summary>
/// Initializes a new instance of the <see cref="T:DataGridExtensions.DataGridFilteringEventArgs" /> class.
/// </summary>
Expand Down
2 changes: 2 additions & 0 deletions src/DataGridExtensions/Tools.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
using System.Windows.Controls;
using System.Windows.Input;

using DataGridExtensions.Behaviors;

/// <summary>
/// Some useful tools for data grids.
/// </summary>
Expand Down

0 comments on commit 8411ea4

Please sign in to comment.