Skip to content

Commit eadbcc6

Browse files
Copilotjfversluis
authored andcommitted
Fix documentation issues - remove T: prefixes, fix generic types, replace "To be added", spell check
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
1 parent d11a0e3 commit eadbcc6

File tree

86 files changed

+205
-205
lines changed

Some content is hidden

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

86 files changed

+205
-205
lines changed

src/Controls/src/Core/AnimationExtensions.cs

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

3535
namespace Microsoft.Maui.Controls
3636
{
37-
/// <summary>Extension methods for <see cref="T:Microsoft.Maui.Controls.IAnimatable"/> objects.</summary>
37+
/// <summary>Extension methods for <see cref="Microsoft.Maui.Controls.IAnimatable"/> objects.</summary>
3838
public static class AnimationExtensions
3939
{
4040
// We use a ConcurrentDictionary because Tweener relies on being able to remove
@@ -219,15 +219,15 @@ public static bool AnimationIsRunning(this IAnimatable self, string handle)
219219
/// <param name="end">The fraction into the current animation at which to stop the animation.</param>
220220
/// <param name="reverseVal">The inverse scale factor to use if <paramref name="reverse"/> is <see langword="true"/>.</param>
221221
/// <param name="reverse">Whether to use the inverse scale factor in <paramref name="reverseVal"/> to deinterpolate.</param>
222-
/// <returns>A function that performs a linear interpolation between <paramref name="start"/> and <paramref name="end"/>. Application developers can pass values between 0.0f and 1.0f to this function in order to recieve a value that is offset from <paramref name="start"/> or <paramref name="end"/>, depending on the value of <paramref name="reverse"/>, by the passed value times the distance between <paramref name="start"/> and <paramref name="end"/>.</returns>
222+
/// <returns>A function that performs a linear interpolation between <paramref name="start"/> and <paramref name="end"/>. Application developers can pass values between 0.0f and 1.0f to this function in order to receive a value that is offset from <paramref name="start"/> or <paramref name="end"/>, depending on the value of <paramref name="reverse"/>, by the passed value times the distance between <paramref name="start"/> and <paramref name="end"/>.</returns>
223223
/// <remarks>If <paramref name="reverse"/> is <see langword="true"/>, then the interpolation happens between <paramref name="start"/> and <paramref name="reverseVal"/>.</remarks>
224224
public static Func<double, double> Interpolate(double start, double end = 1.0f, double reverseVal = 0.0f, bool reverse = false)
225225
{
226226
double target = reverse ? reverseVal : end;
227227
return x => start + (target - start) * x;
228228
}
229229

230-
/// <param name="self">To be added.</param>
230+
/// <param name="self">The object instance.</param>
231231
public static IDisposable Batch(this IAnimatable self) => new BatchObject(self);
232232

233233
static void AbortAnimation(AnimatableKey key)

src/Controls/src/Core/AppLinkEntry.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ public class AppLinkEntry : Element, IAppLinkEntry
99
{
1010
readonly Dictionary<string, string> keyValues;
1111

12-
/// <summary>Creates a new <see cref="T:Microsoft.Maui.Controls.AppLinkEntry"/> with default values.</summary>
12+
/// <summary>Creates a new <see cref="Microsoft.Maui.Controls.AppLinkEntry"/> with default values.</summary>
1313
public AppLinkEntry()
1414
{
1515
keyValues = new(StringComparer.Ordinal);
@@ -45,7 +45,7 @@ public string Description
4545
}
4646

4747
/// <summary>Gets or sets a value that tells whether the item that is identified by the link entry is currently open.</summary>
48-
/// <remarks>Application developers can set this value in <see cref="E:Microsoft.Maui.Controls.Application.PageAppearing"/> and <see cref="E:Microsoft.Maui.Controls.Application.PageDisappearing"/> methods to control whether the app link is shown for indexing or Handoff.</remarks>
48+
/// <remarks>Application developers can set this value in <see cref="Microsoft.Maui.Controls.Application.PageAppearing"/> and <see cref="Microsoft.Maui.Controls.Application.PageDisappearing"/> methods to control whether the app link is shown for indexing or Handoff.</remarks>
4949
public bool IsLinkActive
5050
{
5151
get { return (bool)GetValue(IsLinkActiveProperty); }
@@ -73,7 +73,7 @@ public string Title
7373
set { SetValue(TitleProperty, value); }
7474
}
7575

76-
/// <summary>Creates and returns a new <see cref="T:Microsoft.Maui.Controls.AppLinkEntry"/> for the specified <paramref name="uri"/>.</summary>
76+
/// <summary>Creates and returns a new <see cref="Microsoft.Maui.Controls.AppLinkEntry"/> for the specified <paramref name="uri"/>.</summary>
7777
/// <param name="uri">A URI that can be parsed by the target appliction to recreate a specific state.</param>
7878
public static AppLinkEntry FromUri(Uri uri)
7979
{
@@ -82,8 +82,8 @@ public static AppLinkEntry FromUri(Uri uri)
8282
return appEntry;
8383
}
8484

85-
/// <summary>Returns a string representation of this <see cref="T:Microsoft.Maui.Controls.AppLinkEntry"/>.</summary>
86-
/// <returns>A string representation of this <see cref="T:Microsoft.Maui.Controls.AppLinkEntry"/>.</returns>
85+
/// <summary>Returns a string representation of this <see cref="Microsoft.Maui.Controls.AppLinkEntry"/>.</summary>
86+
/// <returns>A string representation of this <see cref="Microsoft.Maui.Controls.AppLinkEntry"/>.</returns>
8787
public override string ToString()
8888
{
8989
return AppLinkUri.ToString();

src/Controls/src/Core/AppThemeChangedEventArgs.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Microsoft.Maui.Controls
77
/// <include file="../../docs/Microsoft.Maui.Controls/AppThemeChangedEventArgs.xml" path="Type[@FullName='Microsoft.Maui.Controls.AppThemeChangedEventArgs']/Docs/*" />
88
public class AppThemeChangedEventArgs : EventArgs
99
{
10-
/// <param name="appTheme">To be added.</param>
10+
/// <param name="appTheme">The appTheme parameter.</param>
1111
public AppThemeChangedEventArgs(AppTheme appTheme) =>
1212
RequestedTheme = appTheme;
1313

src/Controls/src/Core/AutomationProperties.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ public static void SetExcludedWithChildren(BindableObject bindable, bool? value)
9090
bindable.SetValue(ExcludedWithChildrenProperty, value);
9191
}
9292

93-
/// <summary>Sets another element, such as a <see cref="T:Microsoft.Maui.Controls.Label"/> as the label for <paramref name="bindable"/>.</summary>
93+
/// <summary>Sets another element, such as a <see cref="Microsoft.Maui.Controls.Label"/> as the label for <paramref name="bindable"/>.</summary>
9494
/// <param name="bindable">The object whose label to set.</param>
9595
/// <param name="value">The visual element that will name <paramref name="bindable"/>, or <see langword="null"/> to make <paramref name="bindable"/> its own label.</param>
9696
public static void SetLabeledBy(BindableObject bindable, VisualElement value)

src/Controls/src/Core/BackButtonPressedEventArgs.cs

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

44
namespace Microsoft.Maui.Controls
55
{
6-
/// <summary>Internal use only. Contains arguments for the event that is raised when a back button is pressed.</summary>
6+
/// <summary>Internal API that may change or be removed without notice.</summary>
77
public class BackButtonPressedEventArgs : EventArgs
88
{
9-
/// <summary>Internal use only. Gets or sets a value that indicates whether the back button event has already been handled.</summary>
9+
/// <summary>Internal API that may change or be removed without notice.</summary>
1010
public bool Handled { get; set; }
1111
}
1212
}

src/Controls/src/Core/BindableObjectExtensions.cs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
namespace Microsoft.Maui.Controls
1010
{
11-
/// <summary>Contains convenience extension methods for <see cref="T:Microsoft.Maui.Controls.BindableObject"/>.</summary>
11+
/// <summary>Contains convenience extension methods for <see cref="Microsoft.Maui.Controls.BindableObject"/>.</summary>
1212
public static class BindableObjectExtensions
1313
{
1414
internal static void RefreshPropertyValue(this BindableObject self, BindableProperty property, object value)
@@ -50,11 +50,11 @@ internal static void PropagateBindingContext<T>(this BindableObject self, IEnume
5050
}
5151

5252
/// <summary>Creates and applies a binding to a property.</summary>
53-
/// <param name="self">The <see cref="T:Microsoft.Maui.Controls.BindableObject"/>.</param>
53+
/// <param name="self">The <see cref="Microsoft.Maui.Controls.BindableObject"/>.</param>
5454
/// <param name="targetProperty">The BindableProperty on which to set a binding.</param>
55-
/// <param name="path">A <see cref="T:System.String"/> indicating the property path to bind to.</param>
56-
/// <param name="mode">The <see cref="T:Microsoft.Maui.Controls.BindingMode"/> for the binding. This parameter is optional. Default is <see cref="F:Microsoft.Maui.Controls.BindingMode.Default"/>.</param>
57-
/// <param name="converter">An <see cref="T:Microsoft.Maui.Controls.IValueConverter"/> for the binding. This parameter is optional. Default is <see langword="null"/>.</param>
55+
/// <param name="path">A <see cref="System.String"/> indicating the property path to bind to.</param>
56+
/// <param name="mode">The <see cref="Microsoft.Maui.Controls.BindingMode"/> for the binding. This parameter is optional. Default is <see cref="Microsoft.Maui.Controls.BindingMode.Default"/>.</param>
57+
/// <param name="converter">An <see cref="Microsoft.Maui.Controls.IValueConverter"/> for the binding. This parameter is optional. Default is <see langword="null"/>.</param>
5858
/// <param name="stringFormat">A string used as stringFormat for the binding. This parameter is optional. Default is <see langword="null"/>.</param>
5959
/// <remarks>The following example shows how to use the extension method to set a binding.</remarks>
6060
[RequiresUnreferencedCode(TrimmerConstants.StringPathBindingWarning, Url = TrimmerConstants.ExpressionBasedBindingsDocsUrl)]
@@ -122,10 +122,10 @@ public static void SetBinding(this BindableObject self, BindableProperty targetP
122122
/// </remarks>
123123
/// <typeparam name="TSource">The source type.</typeparam>
124124
/// <typeparam name="TProperty">The property type.</typeparam>
125-
/// <param name="self">The <see cref="T:Microsoft.Maui.Controls.BindableObject" />.</param>
126-
/// <param name="targetProperty">The <see cref="T:Microsoft.Maui.Controls.BindableProperty" /> on which to set a binding.</param>
125+
/// <param name="self">The <see cref="Microsoft.Maui.Controls.BindableObject"/>.</param>
126+
/// <param name="targetProperty">The <see cref="Microsoft.Maui.Controls.BindableProperty"/> on which to set a binding.</param>
127127
/// <param name="getter">An getter method used to retrieve the source property.</param>
128-
/// <param name="mode">The binding mode. This property is optional. Default is <see cref="F:Microsoft.Maui.Controls.BindingMode.Default" />.</param>
128+
/// <param name="mode">The binding mode. This property is optional. Default is <see cref="Microsoft.Maui.Controls.BindingMode.Default"/>.</param>
129129
/// <param name="converter">The converter. This parameter is optional. Default is <see langword="null" />.</param>
130130
/// <param name="converterParameter">An user-defined parameter to pass to the converter. This parameter is optional. Default is <see langword="null" />.</param>
131131
/// <param name="stringFormat">A String format. This parameter is optional. Default is <see langword="null" />.</param>
@@ -218,10 +218,10 @@ internal static bool TrySetAppTheme(
218218

219219
public static void SetAppTheme<T>(this BindableObject self, BindableProperty targetProperty, T light, T dark) => self.SetBinding(targetProperty, new AppThemeBinding { Light = light, Dark = dark });
220220

221-
/// <param name="self">To be added.</param>
222-
/// <param name="targetProperty">To be added.</param>
223-
/// <param name="light">To be added.</param>
224-
/// <param name="dark">To be added.</param>
221+
/// <param name="self">The object instance.</param>
222+
/// <param name="targetProperty">The targetProperty parameter.</param>
223+
/// <param name="light">The light parameter.</param>
224+
/// <param name="dark">The dark parameter.</param>
225225
public static void SetAppThemeColor(this BindableObject self, BindableProperty targetProperty, Color light, Color dark)
226226
=> SetAppTheme(self, targetProperty, light, dark);
227227
}

src/Controls/src/Core/BindableProperty.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
namespace Microsoft.Maui.Controls
1414
{
15-
/// <summary>A BindableProperty is a backing store for properties allowing bindings on <see cref="T:Microsoft.Maui.Controls.BindableObject"/>.</summary>
15+
/// <summary>A BindableProperty is a backing store for properties allowing bindings on <see cref="Microsoft.Maui.Controls.BindableObject"/>.</summary>
1616
[DebuggerDisplay("{PropertyName}")]
1717
[System.ComponentModel.TypeConverter(typeof(BindablePropertyConverter))]
1818
public sealed class BindableProperty

src/Controls/src/Core/BoundsConstraint.cs

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

88
namespace Microsoft.Maui.Controls
99
{
10-
/// <summary>A bounds layout constraint used by <see cref="T:Microsoft.Maui.Controls.Compatibility.RelativeLayout"/>s.</summary>
10+
/// <summary>A bounds layout constraint used by <see cref="Microsoft.Maui.Controls.Compatibility.RelativeLayout"/>s.</summary>
1111
public class BoundsConstraint
1212
{
1313
Func<Rect> _measureFunc;
@@ -19,7 +19,7 @@ public class BoundsConstraint
1919
internal bool CreatedFromExpression { get; set; }
2020
internal IEnumerable<View> RelativeTo { get; set; }
2121

22-
/// <summary>Returns a <see cref="T:Microsoft.Maui.Controls.BoundsConstraint"/> object that contains the compiled version of <paramref name="expression"/> and is relative to either <paramref name="parents"/> or the views referred to in <paramref name="expression"/>.</summary>
22+
/// <summary>Returns a <see cref="Microsoft.Maui.Controls.BoundsConstraint"/> object that contains the compiled version of <paramref name="expression"/> and is relative to either <paramref name="parents"/> or the views referred to in <paramref name="expression"/>.</summary>
2323
/// <param name="expression">The expression from which to compile the constraint.</param>
2424
/// <param name="parents">The parents to consider when compiling the constraint.</param>
2525
public static BoundsConstraint FromExpression(Expression<Func<Rect>> expression, IEnumerable<View> parents = null)

src/Controls/src/Core/Cells/Cell.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
namespace Microsoft.Maui.Controls
1111
{
1212
// Don't add IElementConfiguration<Cell> because it kills performance on UWP structures that use Cells
13-
/// <summary>Provides base class and capabilities for all Microsoft.Maui.Controls cells. Cells are elements meant to be added to <see cref="T:Microsoft.Maui.Controls.ListView"/> or <see cref="T:Microsoft.Maui.Controls.TableView"/>.</summary>
13+
/// <summary>Provides base class and capabilities for all Microsoft.Maui.Controls cells. Cells are elements meant to be added to <see cref="Microsoft.Maui.Controls.ListView"/> or <see cref="Microsoft.Maui.Controls.TableView"/>.</summary>
1414
public abstract class Cell : Element, ICellController, IFlowDirectionController, IPropertyPropagationController, IVisualController, IWindowController, IVisualTreeElement
1515
{
1616
/// <summary>The default height of cells.</summary>
@@ -100,7 +100,7 @@ public IList<MenuItem> ContextActions
100100
}
101101
}
102102

103-
/// <summary>Gets a value that indicates whether the cell has at least one menu item in its <see cref="P:Microsoft.Maui.Controls.Cell.ContextActions"/> list property.</summary>
103+
/// <summary>Gets a value that indicates whether the cell has at least one menu item in its <see cref="Microsoft.Maui.Controls.Cell.ContextActions"/> list property.</summary>
104104
public bool HasContextActions
105105
{
106106
get { return _contextActions != null && _contextActions.Count > 0 && IsEnabled; }

src/Controls/src/Core/Cells/EntryCell.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace Microsoft.Maui.Controls
77
{
8-
/// <summary>A <see cref="T:Microsoft.Maui.Controls.Cell"/> with a label and a single line text entry field.</summary>
8+
/// <summary>A <see cref="Microsoft.Maui.Controls.Cell"/> with a label and a single line text entry field.</summary>
99
public class EntryCell : Cell, ITextAlignmentElement, IEntryCellController, ITextAlignment
1010
{
1111
/// <summary>Bindable property for <see cref="Text"/>.</summary>

0 commit comments

Comments
 (0)