Skip to content

Commit 49e9abe

Browse files
CopilotPureWeen
authored andcommitted
Convert third batch of XML docs to inline documentation
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com> # Conflicts: # src/Controls/src/Core/BoxView/BoxView.cs
1 parent 7f6a599 commit 49e9abe

16 files changed

+87
-63
lines changed

src/Controls/src/Core/BoundsConstraint.cs

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

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

22-
/// <include file="../../docs/Microsoft.Maui.Controls/BoundsConstraint.xml" path="//Member[@MemberName='FromExpression']/Docs/*" />
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>
23+
/// <param name="expression">The expression from which to compile the constraint.</param>
24+
/// <param name="parents">The parents to consider when compiling the constraint.</param>
2325
public static BoundsConstraint FromExpression(Expression<Func<Rect>> expression, IEnumerable<View> parents = null)
2426
{
2527
return FromExpression(expression, false, parents);

src/Controls/src/Core/Button/ButtonsMask.cs

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

55
namespace Microsoft.Maui.Controls
66
{
7-
/// <include file="../../docs/Microsoft.Maui.Controls/ButtonsMask.xml" path="Type[@FullName='Microsoft.Maui.Controls.ButtonsMask']/Docs" />
7+
/// <summary>Flag values that represent mouse buttons.</summary>
88
[Flags]
99
public enum ButtonsMask
1010
{

src/Controls/src/Core/CarouselPage/CarouselPage.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ internal class CarouselPage : MultiPage<ContentPage>, IElementConfiguration<Caro
88
{
99
readonly Lazy<PlatformConfigurationRegistry<CarouselPage>> _platformConfigurationRegistry;
1010

11-
/// <include file="../../docs/Microsoft.Maui.Controls/CarouselPage.xml" path="//Member[@MemberName='.ctor']/Docs/*" />
11+
/// <summary>Initializes a new instance of the CarouselPage class.</summary>
1212
public CarouselPage()
1313
{
1414
_platformConfigurationRegistry = new Lazy<PlatformConfigurationRegistry<CarouselPage>>(() => new PlatformConfigurationRegistry<CarouselPage>(this));

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

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
namespace Microsoft.Maui.Controls
1111
{
1212
// Don't add IElementConfiguration<Cell> because it kills performance on UWP structures that use Cells
13-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="Type[@FullName='Microsoft.Maui.Controls.Cell']/Docs/*" />
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>
1414
public abstract class Cell : Element, ICellController, IFlowDirectionController, IPropertyPropagationController, IVisualController, IWindowController, IVisualTreeElement
1515
{
16-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='DefaultCellHeight']/Docs/*" />
16+
/// <summary>The default height of cells.</summary>
1717
public const int DefaultCellHeight = 40;
1818
/// <summary>Bindable property for <see cref="IsEnabled"/>.</summary>
1919
public static readonly BindableProperty IsEnabledProperty = BindableProperty.Create(nameof(IsEnabled), typeof(bool), typeof(Cell), true, propertyChanged: OnIsEnabledPropertyChanged);
@@ -26,7 +26,8 @@ public abstract class Cell : Element, ICellController, IFlowDirectionController,
2626

2727
bool _nextCallToForceUpdateSizeQueued;
2828

29-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='.ctor']/Docs/*" />
29+
/// <summary>Initializes a new instance of the Cell class.</summary>
30+
/// <remarks>Cell class is abstract, this constructor is never invoked directly.</remarks>
3031
public Cell()
3132
{
3233
_elementConfiguration = new Lazy<ElementConfiguration>(() => new ElementConfiguration(this));
@@ -83,7 +84,8 @@ Window IWindowController.Window
8384
}
8485
}
8586

86-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='ContextActions']/Docs/*" />
87+
/// <summary>Gets a list of menu items to display when the user performs the device-specific context gesture on the Cell.</summary>
88+
/// <remarks>The context gesture on the iOS platform is a left swipe. For Android and Windows Phone operating systems, the context gesture is a press and hold.</remarks>
8789
public IList<MenuItem> ContextActions
8890
{
8991
get
@@ -98,7 +100,7 @@ public IList<MenuItem> ContextActions
98100
}
99101
}
100102

101-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='HasContextActions']/Docs/*" />
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>
102104
public bool HasContextActions
103105
{
104106
get { return _contextActions != null && _contextActions.Count > 0 && IsEnabled; }
@@ -107,7 +109,7 @@ public bool HasContextActions
107109
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='IsContextActionsLegacyModeEnabled']/Docs/*" />
108110
public bool IsContextActionsLegacyModeEnabled { get; set; } = false;
109111

110-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='Height']/Docs/*" />
112+
/// <summary>Gets or sets the height of the Cell.</summary>
111113
public double Height
112114
{
113115
get { return _height; }
@@ -124,14 +126,14 @@ public double Height
124126
}
125127
}
126128

127-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='IsEnabled']/Docs/*" />
129+
/// <summary>Gets or sets the IsEnabled state of the Cell. This is a bindable property.</summary>
128130
public bool IsEnabled
129131
{
130132
get { return (bool)GetValue(IsEnabledProperty); }
131133
set { SetValue(IsEnabledProperty, value); }
132134
}
133135

134-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='RenderHeight']/Docs/*" />
136+
/// <summary>Gets the height of the rendered cell on the device.</summary>
135137
public double RenderHeight
136138
{
137139
get
@@ -157,7 +159,8 @@ public double RenderHeight
157159
[EditorBrowsable(EditorBrowsableState.Never)]
158160
public event EventHandler ForceUpdateSizeRequested;
159161

160-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='ForceUpdateSize']/Docs/*" />
162+
/// <summary>Immediately updates the cell's size.</summary>
163+
/// <remarks>Developers can call this method to update the cell's size, even if the cell is currently visible. Developers should note that this operation can be expensive.</remarks>
161164
public void ForceUpdateSize()
162165
{
163166
if (_nextCallToForceUpdateSizeQueued)
@@ -221,7 +224,7 @@ protected override void OnPropertyChanging(string propertyName = null)
221224
base.OnPropertyChanging(propertyName);
222225
}
223226

224-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='SendAppearing']/Docs/*" />
227+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
225228
[EditorBrowsable(EditorBrowsableState.Never)]
226229
public void SendAppearing()
227230
{
@@ -231,7 +234,7 @@ public void SendAppearing()
231234
container?.SendCellAppearing(this);
232235
}
233236

234-
/// <include file="../../../docs/Microsoft.Maui.Controls/Cell.xml" path="//Member[@MemberName='SendDisappearing']/Docs/*" />
237+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
235238
[EditorBrowsable(EditorBrowsableState.Never)]
236239
public void SendDisappearing()
237240
{

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

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

66
namespace Microsoft.Maui.Controls
77
{
8-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="Type[@FullName='Microsoft.Maui.Controls.EntryCell']/Docs/*" />
8+
/// <summary>A <see cref="T: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>
@@ -29,7 +29,7 @@ public class EntryCell : Cell, ITextAlignmentElement, IEntryCellController, ITex
2929
/// <summary>Bindable property for <see cref="VerticalTextAlignment"/>.</summary>
3030
public static readonly BindableProperty VerticalTextAlignmentProperty = TextAlignmentElement.VerticalTextAlignmentProperty;
3131

32-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="//Member[@MemberName='HorizontalTextAlignment']/Docs/*" />
32+
/// <summary>Gets or sets the horizontal alignement of the Text property. This is a bindable property.</summary>
3333
public TextAlignment HorizontalTextAlignment
3434
{
3535
get { return (TextAlignment)GetValue(TextAlignmentElement.HorizontalTextAlignmentProperty); }
@@ -43,36 +43,36 @@ public TextAlignment VerticalTextAlignment
4343
set { SetValue(TextAlignmentElement.VerticalTextAlignmentProperty, value); }
4444
}
4545

46-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="//Member[@MemberName='Keyboard']/Docs/*" />
46+
/// <summary>Gets or sets the Keyboard to display while editing the EntryCell. This is a bindable property.</summary>
4747
[System.ComponentModel.TypeConverter(typeof(Converters.KeyboardTypeConverter))]
4848
public Keyboard Keyboard
4949
{
5050
get { return (Keyboard)GetValue(KeyboardProperty); }
5151
set { SetValue(KeyboardProperty, value); }
5252
}
5353

54-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="//Member[@MemberName='Label']/Docs/*" />
54+
/// <summary>Gets or sets the fixed text presented next to the Entry in the EntryCell. This is a bindable property.</summary>
5555
public string Label
5656
{
5757
get { return (string)GetValue(LabelProperty); }
5858
set { SetValue(LabelProperty, value); }
5959
}
6060

61-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="//Member[@MemberName='LabelColor']/Docs/*" />
61+
/// <summary>Gets or sets the Color used for rendering the Label property. This is a bindable property.</summary>
6262
public Color LabelColor
6363
{
6464
get { return (Color)GetValue(LabelColorProperty); }
6565
set { SetValue(LabelColorProperty, value); }
6666
}
6767

68-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="//Member[@MemberName='Placeholder']/Docs/*" />
68+
/// <summary>Gets or sets the placeholder text displayed in the Entry when the Text is null or empty. This is a bindable property.</summary>
6969
public string Placeholder
7070
{
7171
get { return (string)GetValue(PlaceholderProperty); }
7272
set { SetValue(PlaceholderProperty, value); }
7373
}
7474

75-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="//Member[@MemberName='Text']/Docs/*" />
75+
/// <summary>Gets or sets the content of the Entry of the EntryCell. This is a bindable property.</summary>
7676
public string Text
7777
{
7878
get { return (string)GetValue(TextProperty); }
@@ -81,7 +81,7 @@ public string Text
8181

8282
public event EventHandler Completed;
8383

84-
/// <include file="../../../docs/Microsoft.Maui.Controls/EntryCell.xml" path="//Member[@MemberName='SendCompleted']/Docs/*" />
84+
/// <summary>For internal use by the Microsoft.Maui.Controls platform.</summary>
8585
[EditorBrowsable(EditorBrowsableState.Never)]
8686
public void SendCompleted()
8787
=> Completed?.Invoke(this, EventArgs.Empty);

src/Controls/src/Core/Cells/ImageCell.cs

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

44
namespace Microsoft.Maui.Controls
55
{
6-
/// <include file="../../../docs/Microsoft.Maui.Controls/ImageCell.xml" path="Type[@FullName='Microsoft.Maui.Controls.ImageCell']/Docs/*" />
6+
/// <summary>A <see cref="T:Microsoft.Maui.Controls.TextCell"/> that has an image.</summary>
77
public class ImageCell : TextCell
88
{
99
/// <summary>Bindable property for <see cref="ImageSource"/>.</summary>
1010
public static readonly BindableProperty ImageSourceProperty = BindableProperty.Create(nameof(ImageSource), typeof(ImageSource), typeof(ImageCell), null,
1111
propertyChanging: (bindable, oldvalue, newvalue) => ((ImageCell)bindable).OnSourcePropertyChanging((ImageSource)oldvalue, (ImageSource)newvalue),
1212
propertyChanged: (bindable, oldvalue, newvalue) => ((ImageCell)bindable).OnSourcePropertyChanged((ImageSource)oldvalue, (ImageSource)newvalue));
1313

14-
/// <include file="../../../docs/Microsoft.Maui.Controls/ImageCell.xml" path="//Member[@MemberName='.ctor']/Docs/*" />
14+
/// <summary>Initializes a new instance of the ImageCell class.</summary>
1515
public ImageCell()
1616
{
1717
Disappearing += (sender, e) =>
@@ -22,7 +22,7 @@ public ImageCell()
2222
};
2323
}
2424

25-
/// <include file="../../../docs/Microsoft.Maui.Controls/ImageCell.xml" path="//Member[@MemberName='ImageSource']/Docs/*" />
25+
/// <summary>Gets or sets the ImageSource from which the Image is loaded. This is a bindable property.</summary>
2626
[System.ComponentModel.TypeConverter(typeof(ImageSourceConverter))]
2727
public ImageSource ImageSource
2828
{

src/Controls/src/Core/Cells/SwitchCell.cs

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

55
namespace Microsoft.Maui.Controls
66
{
7-
/// <include file="../../../docs/Microsoft.Maui.Controls/SwitchCell.xml" path="Type[@FullName='Microsoft.Maui.Controls.SwitchCell']/Docs/*" />
7+
/// <summary>A <see cref="T:Microsoft.Maui.Controls.Cell"/> with a label and an on/off switch.</summary>
88
public class SwitchCell : Cell
99
{
1010
/// <summary>Bindable property for <see cref="On"/>.</summary>
@@ -27,14 +27,14 @@ public Color OnColor
2727
set { SetValue(OnColorProperty, value); }
2828
}
2929

30-
/// <include file="../../../docs/Microsoft.Maui.Controls/SwitchCell.xml" path="//Member[@MemberName='On']/Docs/*" />
30+
/// <summary>Gets or sets the state of the switch. This is a bindable property.</summary>
3131
public bool On
3232
{
3333
get { return (bool)GetValue(OnProperty); }
3434
set { SetValue(OnProperty, value); }
3535
}
3636

37-
/// <include file="../../../docs/Microsoft.Maui.Controls/SwitchCell.xml" path="//Member[@MemberName='Text']/Docs/*" />
37+
/// <summary>Gets or sets the text displayed next to the switch. This is a bindable property.</summary>
3838
public string Text
3939
{
4040
get { return (string)GetValue(TextProperty); }

src/Controls/src/Core/Cells/TextCell.cs

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

77
namespace Microsoft.Maui.Controls
88
{
9-
/// <include file="../../../docs/Microsoft.Maui.Controls/TextCell.xml" path="Type[@FullName='Microsoft.Maui.Controls.TextCell']/Docs/*" />
9+
/// <summary>A <see cref="T:Microsoft.Maui.Controls.Cell"/> with primary <see cref="P:Microsoft.Maui.Controls.TextCell.Text"/> and <see cref="P:Microsoft.Maui.Controls.TextCell.Detail"/> text.</summary>
1010
public class TextCell : Cell, ICommandElement
1111
{
1212
/// <summary>Bindable property for <see cref="Command"/>.</summary>
@@ -35,42 +35,45 @@ public class TextCell : Cell, ICommandElement
3535
/// <summary>Bindable property for <see cref="DetailColor"/>.</summary>
3636
public static readonly BindableProperty DetailColorProperty = BindableProperty.Create(nameof(DetailColor), typeof(Color), typeof(TextCell), null);
3737

38-
/// <include file="../../../docs/Microsoft.Maui.Controls/TextCell.xml" path="//Member[@MemberName='Command']/Docs/*" />
38+
/// <summary>Gets or sets the ICommand to be executed when the TextCell is tapped. This is a bindable property.</summary>
39+
/// <remarks>Setting the Command property has a side effect of changing the Enabled property depending on ICommand.CanExecute.</remarks>
3940
public ICommand Command
4041
{
4142
get { return (ICommand)GetValue(CommandProperty); }
4243
set { SetValue(CommandProperty, value); }
4344
}
4445

45-
/// <include file="../../../docs/Microsoft.Maui.Controls/TextCell.xml" path="//Member[@MemberName='CommandParameter']/Docs/*" />
46+
/// <summary>Gets or sets the parameter passed when invoking the Command. This is a bindable property.</summary>
4647
public object CommandParameter
4748
{
4849
get { return GetValue(CommandParameterProperty); }
4950
set { SetValue(CommandParameterProperty, value); }
5051
}
5152

52-
/// <include file="../../../docs/Microsoft.Maui.Controls/TextCell.xml" path="//Member[@MemberName='Detail']/Docs/*" />
53+
/// <summary>Gets or sets the secondary text to be displayed in the TextCell. This is a bindable property.</summary>
5354
public string Detail
5455
{
5556
get { return (string)GetValue(DetailProperty); }
5657
set { SetValue(DetailProperty, value); }
5758
}
5859

59-
/// <include file="../../../docs/Microsoft.Maui.Controls/TextCell.xml" path="//Member[@MemberName='DetailColor']/Docs/*" />
60+
/// <summary>Gets or sets the color to render the secondary text. This is a bindable property.</summary>
61+
/// <remarks>Not all platforms may support transparent text rendering. Using Color.Default will result in the system theme color being used.</remarks>
6062
public Color DetailColor
6163
{
6264
get { return (Color)GetValue(DetailColorProperty); }
6365
set { SetValue(DetailColorProperty, value); }
6466
}
6567

66-
/// <include file="../../../docs/Microsoft.Maui.Controls/TextCell.xml" path="//Member[@MemberName='Text']/Docs/*" />
68+
/// <summary>Gets or sets the primary text to be displayed. This is a bindable property.</summary>
6769
public string Text
6870
{
6971
get { return (string)GetValue(TextProperty); }
7072
set { SetValue(TextProperty, value); }
7173
}
7274

73-
/// <include file="../../../docs/Microsoft.Maui.Controls/TextCell.xml" path="//Member[@MemberName='TextColor']/Docs/*" />
75+
/// <summary>Gets or sets the color to render the primary text. This is a bindable property.</summary>
76+
/// <remarks>Not all platforms may support transparent text rendering. Using Color.Default will result in the system theme color being used. Color.Default is the default color value.</remarks>
7477
public Color TextColor
7578
{
7679
get { return (Color)GetValue(TextColorProperty); }

src/Controls/src/Core/Cells/ViewCell.cs

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

55
namespace Microsoft.Maui.Controls
66
{
7-
/// <include file="../../../docs/Microsoft.Maui.Controls/ViewCell.xml" path="Type[@FullName='Microsoft.Maui.Controls.ViewCell']/Docs/*" />
7+
/// <summary>A <see cref="T:Microsoft.Maui.Controls.Cell"/> containing a developer-defined <see cref="T:Microsoft.Maui.Controls.View"/>.</summary>
88
[ContentProperty("View")]
99
public class ViewCell : Cell
1010
{
1111
View _view;
1212

13-
/// <include file="../../../docs/Microsoft.Maui.Controls/ViewCell.xml" path="//Member[@MemberName='View']/Docs/*" />
13+
/// <summary>Gets or sets the View representing the content of the ViewCell.</summary>
1414
public View View
1515
{
1616
get { return _view; }

src/Controls/src/Core/CheckBox/CheckedChangedEventArgs.cs

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

44
namespace Microsoft.Maui.Controls
55
{
6-
/// <include file="../../docs/Microsoft.Maui.Controls/CheckedChangedEventArgs.xml" path="Type[@FullName='Microsoft.Maui.Controls.CheckedChangedEventArgs']/Docs/*" />
6+
/// <summary>Event Args for <see cref="T:Microsoft.Maui.Controls.CheckBox"/>'s <see cref="E:Microsoft.Maui.Controls.CheckBox.CheckedChanged"/> event.</summary>
77
public class CheckedChangedEventArgs : EventArgs
88
{
9-
/// <include file="../../docs/Microsoft.Maui.Controls/CheckedChangedEventArgs.xml" path="//Member[@MemberName='.ctor']/Docs/*" />
9+
/// <summary>Creates a new <see cref="T:Microsoft.Maui.Controls.CheckedChangedEventArgs"/> specifying whether the <see cref="T:Microsoft.Maui.Controls.CheckBox"/> is checked.</summary>
10+
/// <param name="value">Boolean value indicating whether the <see cref="T:Microsoft.Maui.Controls.CheckBox"/> is checked.</param>
1011
public CheckedChangedEventArgs(bool value)
1112
{
1213
Value = value;
1314
}
1415

15-
/// <include file="../../docs/Microsoft.Maui.Controls/CheckedChangedEventArgs.xml" path="//Member[@MemberName='Value']/Docs/*" />
16+
/// <summary>Boolean value indicating whether the <see cref="T:Microsoft.Maui.Controls.CheckBox"/> is checked.</summary>
1617
public bool Value { get; private set; }
1718
}
1819
}

0 commit comments

Comments
 (0)