Skip to content

Commit d11a0e3

Browse files
Copilotjfversluis
authored and
PureWeen
committed
Convert fifth batch (100 files) of XML docs to inline documentation - Major milestone!
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
1 parent ca3ec71 commit d11a0e3

File tree

100 files changed

+617
-425
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+617
-425
lines changed

‎src/Controls/src/Core/Internals/NavigationRequestedEventArgs.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace Microsoft.Maui.Controls.Internals
66
{
7-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NavigationRequestedEventArgs.xml" path="Type[@FullName='Microsoft.Maui.Controls.Internals.NavigationRequestedEventArgs']/Docs/*" />
7+
/// <summary>For internal use by platform renderers.</summary>
88
[EditorBrowsable(EditorBrowsableState.Never)]
99
public class NavigationRequestedEventArgs : NavigationEventArgs
1010
{
@@ -20,16 +20,16 @@ public NavigationRequestedEventArgs(Page page, Page before, bool animated) : thi
2020
BeforePage = before;
2121
}
2222

23-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NavigationRequestedEventArgs.xml" path="//Member[@MemberName='Animated']/Docs/*" />
23+
/// <summary>For internal use by platform renderers.</summary>
2424
public bool Animated { get; set; }
2525

26-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NavigationRequestedEventArgs.xml" path="//Member[@MemberName='BeforePage']/Docs/*" />
26+
/// <summary>For internal use by platform renderers.</summary>
2727
public Page BeforePage { get; set; }
2828

29-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NavigationRequestedEventArgs.xml" path="//Member[@MemberName='Task']/Docs/*" />
29+
/// <summary>For internal use by platform renderers.</summary>
3030
public Task<bool> Task { get; set; }
3131

32-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NavigationRequestedEventArgs.xml" path="//Member[@MemberName='RequestType']/Docs/*" />
32+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
3333
public NavigationRequestType RequestType { get; set; } = NavigationRequestType.Unknown;
3434
}
3535
}

‎src/Controls/src/Core/Internals/NotifyCollectionChangedEventArgsEx.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace Microsoft.Maui.Controls.Internals
77
{
8-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NotifyCollectionChangedEventArgsEx.xml" path="Type[@FullName='Microsoft.Maui.Controls.Internals.NotifyCollectionChangedEventArgsEx']/Docs/*" />
8+
/// <summary>For internal use by platform renderers.</summary>
99
[EditorBrowsable(EditorBrowsableState.Never)]
1010
public class NotifyCollectionChangedEventArgsEx : NotifyCollectionChangedEventArgs
1111
{
@@ -75,7 +75,7 @@ public NotifyCollectionChangedEventArgsEx(int count, NotifyCollectionChangedActi
7575
Count = count;
7676
}
7777

78-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NotifyCollectionChangedEventArgsEx.xml" path="//Member[@MemberName='Count']/Docs/*" />
78+
/// <summary>For internal use by platform renderers.</summary>
7979
public int Count { get; private set; }
8080
}
8181
}

‎src/Controls/src/Core/Internals/NotifyCollectionChangedEventArgsExtensions.cs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace Microsoft.Maui.Controls.Internals
88
{
9-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NotifyCollectionChangedEventArgsExtensions.xml" path="Type[@FullName='Microsoft.Maui.Controls.Internals.NotifyCollectionChangedEventArgsExtensions']/Docs/*" />
9+
/// <summary>For internal use by platform renderers.</summary>
1010
[EditorBrowsable(EditorBrowsableState.Never)]
1111
public static class NotifyCollectionChangedEventArgsExtensions
1212
{
@@ -87,7 +87,10 @@ public static NotifyCollectionChangedAction Apply(this NotifyCollectionChangedEv
8787
return self.Action;
8888
}
8989

90-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/NotifyCollectionChangedEventArgsExtensions.xml" path="//Member[@MemberName='WithCount']/Docs/*" />
90+
/// <summary>For internal use by platform renderers.</summary>
91+
/// <param name="e">For internal use by the Microsoft.Maui.Controls platform.</param>
92+
/// <param name="count">For internal use by the Microsoft.Maui.Controls platform.</param>
93+
/// <returns>For internal use by the Microsoft.Maui.Controls platform.</returns>
9194
public static NotifyCollectionChangedEventArgsEx WithCount(this NotifyCollectionChangedEventArgs e, int count)
9295
{
9396
switch (e.Action)

‎src/Controls/src/Core/Internals/PageExtensions.cs‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33

44
namespace Microsoft.Maui.Controls.Internals
55
{
6-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/PageExtensions.xml" path="Type[@FullName='Microsoft.Maui.Controls.Internals.PageExtensions']/Docs/*" />
6+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
77
[EditorBrowsable(EditorBrowsableState.Never)]
88
public static class PageExtensions
99
{
10-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/PageExtensions.xml" path="//Member[@MemberName='AncestorToRoot']/Docs/*" />
10+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
11+
/// <param name="page">For internal use by the Microsoft.Maui.Controls platform.</param>
12+
/// <returns>For internal use by the Microsoft.Maui.Controls platform.</returns>
1113
public static Page AncestorToRoot(this Page page)
1214
{
1315
Element parent = page;

‎src/Controls/src/Core/Internals/PreserveAttribute.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44

55
namespace Microsoft.Maui.Controls.Internals
66
{
7-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/PreserveAttribute.xml" path="Type[@FullName='Microsoft.Maui.Controls.Internals.PreserveAttribute']/Docs/*" />
7+
/// <summary>For internal use by platform renderers.</summary>
88
[AttributeUsage(AttributeTargets.All)]
99
[EditorBrowsable(EditorBrowsableState.Never)]
1010
public sealed class PreserveAttribute : Attribute
1111
{
12-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/PreserveAttribute.xml" path="//Member[@MemberName='AllMembers']/Docs/*" />
12+
/// <summary>For internal use by platform renderers.</summary>
1313
public bool AllMembers;
14-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/PreserveAttribute.xml" path="//Member[@MemberName='Conditional']/Docs/*" />
14+
/// <summary>For internal use by platform renderers.</summary>
1515
public bool Conditional;
1616

1717
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/PreserveAttribute.xml" path="//Member[@MemberName='.ctor'][2]/Docs/*" />

‎src/Controls/src/Core/Internals/ProfilePage.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ private static void AppendProfile(StringBuilder sb, long profiledMs, bool showZe
9393
}
9494
}
9595

96-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/ContentPageEx.xml" path="//Member[@MemberName='LoadProfile']/Docs/*" />
96+
/// <param name="page">To be added.</param>
9797
public static void LoadProfile(this ContentPage page)
9898
{
9999
Profile.Stop();

‎src/Controls/src/Core/Internals/PropertyPropagationExtensions.cs‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,9 @@ internal static void PropagatePropertyChanged(string propertyName, Element eleme
4747
}
4848
}
4949

50-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/PropertyPropagationExtensions.xml" path="//Member[@MemberName='PropagatePropertyChanged']/Docs/*" />
50+
/// <param name="propertyName">To be added.</param>
51+
/// <param name="target">To be added.</param>
52+
/// <param name="source">To be added.</param>
5153
public static void PropagatePropertyChanged(string propertyName, Element target, Element source)
5254
{
5355
if (propertyName == null || propertyName == VisualElement.FlowDirectionProperty.PropertyName)

‎src/Controls/src/Core/Internals/ResourceLoader.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55

66
namespace Microsoft.Maui.Controls.Internals
77
{
8-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/ResourceLoader.xml" path="Type[@FullName='Microsoft.Maui.Controls.Internals.ResourceLoader']/Docs/*" />
8+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
99
[EditorBrowsable(EditorBrowsableState.Never)]
1010
public static class ResourceLoader
1111
{
1212
static Func<ResourceLoadingQuery, ResourceLoadingResponse> _resourceProvider2;
13-
/// <include file="../../../docs/Microsoft.Maui.Controls.Internals/ResourceLoader.xml" path="//Member[@MemberName='ResourceProvider2']/Docs/*" />
13+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
1414
public static Func<ResourceLoadingQuery, ResourceLoadingResponse> ResourceProvider2
1515
{
1616
get => _resourceProvider2;

‎src/Controls/src/Core/ItemTappedEventArgs.cs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace Microsoft.Maui.Controls
55
{
6-
/// <include file="../../docs/Microsoft.Maui.Controls/ItemTappedEventArgs.xml" path="Type[@FullName='Microsoft.Maui.Controls.ItemTappedEventArgs']/Docs/*" />
6+
/// <summary>Event arguments for the <see cref="E:Microsoft.Maui.Controls.ListView.ItemTapped"/> event.</summary>
77
public class ItemTappedEventArgs : EventArgs
88
{
99
/// <include file="../../docs/Microsoft.Maui.Controls/ItemTappedEventArgs.xml" path="//Member[@MemberName='.ctor'][2]/Docs/*" />
@@ -14,10 +14,10 @@ public ItemTappedEventArgs(object group, object item, int itemIndex)
1414
ItemIndex = itemIndex;
1515
}
1616

17-
/// <include file="../../docs/Microsoft.Maui.Controls/ItemTappedEventArgs.xml" path="//Member[@MemberName='Group']/Docs/*" />
17+
/// <summary>The collection of elements to which the tapped item belongs.</summary>
1818
public object Group { get; private set; }
1919

20-
/// <include file="../../docs/Microsoft.Maui.Controls/ItemTappedEventArgs.xml" path="//Member[@MemberName='Item']/Docs/*" />
20+
/// <summary>The visual element that the user tapped.</summary>
2121
public object Item { get; private set; }
2222

2323
/// <include file="../../docs/Microsoft.Maui.Controls/ItemTappedEventArgs.xml" path="//Member[@MemberName='ItemIndex']/Docs/*" />

‎src/Controls/src/Core/ItemVisibilityEventArgs.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace Microsoft.Maui.Controls
55
{
6-
/// <include file="../../docs/Microsoft.Maui.Controls/ItemVisibilityEventArgs.xml" path="Type[@FullName='Microsoft.Maui.Controls.ItemVisibilityEventArgs']/Docs/*" />
6+
/// <summary>Event args when an item's visibility has been changed in a <see cref="T:Microsoft.Maui.Controls.ListView"/>.</summary>
77
public sealed class ItemVisibilityEventArgs : EventArgs
88
{
99
/// <include file="../../docs/Microsoft.Maui.Controls/ItemVisibilityEventArgs.xml" path="//Member[@MemberName='.ctor'][2]/Docs/*" />
@@ -13,7 +13,7 @@ public ItemVisibilityEventArgs(object item, int itemIndex)
1313
ItemIndex = itemIndex;
1414
}
1515

16-
/// <include file="../../docs/Microsoft.Maui.Controls/ItemVisibilityEventArgs.xml" path="//Member[@MemberName='Item']/Docs/*" />
16+
/// <summary>The item from the <see cref="P:Microsoft.Maui.Controls.ItemsView`1.ItemsSource"/> whose visibility has changed.</summary>
1717
public object Item { get; private set; }
1818

1919
/// <include file="../../docs/Microsoft.Maui.Controls/ItemVisibilityEventArgs.xml" path="//Member[@MemberName='ItemIndex']/Docs/*" />

0 commit comments

Comments
 (0)