Skip to content

Commit 95193a7

Browse files
Copilotjfversluis
authored andcommitted
Convert first batch of XML docs to inline documentation
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
1 parent 1a601e8 commit 95193a7

File tree

5 files changed

+49
-9
lines changed

5 files changed

+49
-9
lines changed

src/Controls/src/Core/EditorAutoSizeOption.cs

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

55
namespace Microsoft.Maui.Controls
66
{
7-
/// <include file="../../docs/Microsoft.Maui.Controls/EditorAutoSizeOption.xml" path="Type[@FullName='Microsoft.Maui.Controls.EditorAutoSizeOption']/Docs/*" />
7+
/// <summary>Enumerates values that control whether an editor will change size to accommodate input as the user enters it.</summary>
88
public enum EditorAutoSizeOption
99
{
10-
/// <include file="../../docs/Microsoft.Maui.Controls/EditorAutoSizeOption.xml" path="//Member[@MemberName='Disabled']/Docs/*" />
10+
/// <summary>Automatic resizing is not enabled. This is the default value.</summary>
1111
Disabled = 0,
12-
/// <include file="../../docs/Microsoft.Maui.Controls/EditorAutoSizeOption.xml" path="//Member[@MemberName='TextChanges']/Docs/*" />
12+
/// <summary>Automatic resizing is enabled.</summary>
1313
TextChanges = 1
1414
}
1515
}

src/Controls/src/Core/HtmlWebViewSource.cs

Lines changed: 5 additions & 4 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/HtmlWebViewSource.xml" path="Type[@FullName='Microsoft.Maui.Controls.HtmlWebViewSource']/Docs/*" />
6+
/// <summary>A WebViewSource bound to an HTML-formatted string.</summary>
77
public class HtmlWebViewSource : WebViewSource
88
{
99
/// <summary>Bindable property for <see cref="Html"/>.</summary>
@@ -14,21 +14,22 @@ public class HtmlWebViewSource : WebViewSource
1414
public static readonly BindableProperty BaseUrlProperty = BindableProperty.Create(nameof(BaseUrl), typeof(string), typeof(HtmlWebViewSource), default(string),
1515
propertyChanged: (bindable, oldvalue, newvalue) => ((HtmlWebViewSource)bindable).OnSourceChanged());
1616

17-
/// <include file="../../docs/Microsoft.Maui.Controls/HtmlWebViewSource.xml" path="//Member[@MemberName='BaseUrl']/Docs/*" />
17+
/// <summary>The base URL for the source HTML document. This is a bindable property.</summary>
1818
public string BaseUrl
1919
{
2020
get { return (string)GetValue(BaseUrlProperty); }
2121
set { SetValue(BaseUrlProperty, value); }
2222
}
2323

24-
/// <include file="../../docs/Microsoft.Maui.Controls/HtmlWebViewSource.xml" path="//Member[@MemberName='Html']/Docs/*" />
24+
/// <summary>The HTML content. This is a bindable property.</summary>
2525
public string Html
2626
{
2727
get { return (string)GetValue(HtmlProperty); }
2828
set { SetValue(HtmlProperty, value); }
2929
}
3030

31-
/// <include file="../../docs/Microsoft.Maui.Controls/HtmlWebViewSource.xml" path="//Member[@MemberName='Load']/Docs/*" />
31+
/// <summary>Loads the specified <paramref name="renderer"/> with the current base URL and HTML.</summary>
32+
/// <param name="renderer">The renderer into which to load html content.</param>
3233
[EditorBrowsable(EditorBrowsableState.Never)]
3334
public override void Load(IWebViewDelegate renderer)
3435
{
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#nullable disable
2+
using System.ComponentModel;
3+
4+
namespace Microsoft.Maui.Controls
5+
{
6+
/// <summary>A WebViewSource bound to an HTML-formatted string.</summary>
7+
public class HtmlWebViewSource : WebViewSource
8+
{
9+
/// <summary>Bindable property for <see cref="Html"/>.</summary>
10+
public static readonly BindableProperty HtmlProperty = BindableProperty.Create(nameof(Html), typeof(string), typeof(HtmlWebViewSource), default(string),
11+
propertyChanged: (bindable, oldvalue, newvalue) => ((HtmlWebViewSource)bindable).OnSourceChanged());
12+
13+
/// <summary>Bindable property for <see cref="BaseUrl"/>.</summary>
14+
public static readonly BindableProperty BaseUrlProperty = BindableProperty.Create(nameof(BaseUrl), typeof(string), typeof(HtmlWebViewSource), default(string),
15+
propertyChanged: (bindable, oldvalue, newvalue) => ((HtmlWebViewSource)bindable).OnSourceChanged());
16+
17+
/// <summary>The base URL for the source HTML document.</summary>
18+
public string BaseUrl
19+
{
20+
get { return (string)GetValue(BaseUrlProperty); }
21+
set { SetValue(BaseUrlProperty, value); }
22+
}
23+
24+
/// <summary>The HTML content. This is a bindable property.</summary>
25+
public string Html
26+
{
27+
get { return (string)GetValue(HtmlProperty); }
28+
set { SetValue(HtmlProperty, value); }
29+
}
30+
31+
/// <summary>Loads the specified <paramref name="renderer"/> with the current base URL and HTML.</summary>
32+
/// <param name="renderer">The renderer into which to load html content.</param>
33+
[EditorBrowsable(EditorBrowsableState.Never)]
34+
public override void Load(IWebViewDelegate renderer)
35+
{
36+
renderer.LoadHtml(Html, BaseUrl);
37+
}
38+
}
39+
}

src/Controls/src/Core/ListStringTypeConverter.cs

Lines changed: 1 addition & 1 deletion
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/ListStringTypeConverter.xml" path="Type[@FullName='Microsoft.Maui.Controls.ListStringTypeConverter']/Docs/*" />
10+
/// <summary>Type converter for converting properly formatted string lists to lists.</summary>
1111
[Xaml.ProvideCompiled("Microsoft.Maui.Controls.XamlC.ListStringTypeConverter")]
1212
public class ListStringTypeConverter : TypeConverter
1313
{

src/Controls/src/Core/SolidColorBrush.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public virtual Color Color
4141
set => SetValue(ColorProperty, value);
4242
}
4343

44-
/// <include file="../../docs/Microsoft.Maui.Controls/SolidColorBrush.xml" path="//Member[@MemberName='Equals']/Docs/*" />
44+
/// <param name="obj">To be added.</param>
4545
public override bool Equals(object obj)
4646
{
4747
if (!(obj is SolidColorBrush dest))

0 commit comments

Comments
 (0)