Skip to content

Commit 760d510

Browse files
DianaSoltaniDiana Soltanijfversluis
authored
Migrate xml docs directly into code for ExtensionPoints (#24333)
* Move android platform documentation out of XML file * move other platform api docs into ExtensionPoints * Fix feedback --------- Co-authored-by: Diana Soltani <dianasoltani@microsoft.com> Co-authored-by: Gerald Versluis <gerald.versluis@microsoft.com>
1 parent 1e33657 commit 760d510

File tree

6 files changed

+41
-35
lines changed

6 files changed

+41
-35
lines changed

‎src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/Android.xml

-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@
1616
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
1717
</Interface>
1818
</Interfaces>
19-
<Docs>
20-
<summary>Marker class that identifies the Android platform.</summary>
21-
<remarks>
22-
<para>Developers specify the type name of this marker class to the <see cref="M:Microsoft.Maui.Controls.IElementConfiguration`1.On``1" /> method to specify the underlying Android control on which to run a platform-specific effect.</para>
23-
</remarks>
24-
</Docs>
2519
<Members>
2620
<Member MemberName=".ctor">
2721
<MemberSignature Language="C#" Value="public Android ();" />

‎src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/Tizen.xml

-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@
1616
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
1717
</Interface>
1818
</Interfaces>
19-
<Docs>
20-
<summary>Marker class that identifies the Tizen platform.</summary>
21-
<remarks>
22-
<para>Developers specify the type name of this marker class to the <see cref="M:Microsoft.Maui.Controls.IElementConfiguration`1.On``1" /> method to specify the underlying Tizen control on which to run a platform-specific effect.</para>
23-
</remarks>
24-
</Docs>
2519
<Members>
2620
<Member MemberName=".ctor">
2721
<MemberSignature Language="C#" Value="public Tizen ();" />

‎src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/Windows.xml

-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@
1616
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
1717
</Interface>
1818
</Interfaces>
19-
<Docs>
20-
<summary>Marker class that identifies the Windows platform.</summary>
21-
<remarks>
22-
<para>Developers specify the type name of this marker class to the <see cref="M:Microsoft.Maui.Controls.IElementConfiguration`1.On``1" /> method to specify the underlying Windows control on which to run a platform-specific effect.</para>
23-
</remarks>
24-
</Docs>
2519
<Members>
2620
<Member MemberName=".ctor">
2721
<MemberSignature Language="C#" Value="public Windows ();" />

‎src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/iOS.xml

-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@
1616
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
1717
</Interface>
1818
</Interfaces>
19-
<Docs>
20-
<summary>Marker class that identifies the iOS platform.</summary>
21-
<remarks>
22-
<para>Developers specify the type name of this marker class to the <see cref="M:Microsoft.Maui.Controls.IElementConfiguration`1.On``1" /> method to specify the underlying iOS control on which to run a platform-specific effect.</para>
23-
</remarks>
24-
</Docs>
2519
<Members>
2620
<Member MemberName=".ctor">
2721
<MemberSignature Language="C#" Value="public iOS ();" />

‎src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/macOS.xml

-4
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,6 @@
1616
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
1717
</Interface>
1818
</Interfaces>
19-
<Docs>
20-
<summary>Marker class that identifies the macOS platform.</summary>
21-
<remarks>Developers specify the type name of this marker class to the <see cref="M:Microsoft.Maui.Controls.IElementConfiguration`1.On``1" /> method to specify the underlying iOS control on which to run a platform-specific effect.</remarks>
22-
</Docs>
2319
<Members>
2420
<Member MemberName=".ctor">
2521
<MemberSignature Language="C#" Value="public macOS ();" />

‎src/Controls/src/Core/PlatformConfiguration/ExtensionPoints.cs

+41-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,50 @@
1-
21
namespace Microsoft.Maui.Controls.PlatformConfiguration
32
{
4-
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/Android.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.Android']/Docs/*" />
3+
/// <summary>
4+
/// Marker class that identifies the Android platform.
5+
/// </summary>
6+
/// <remarks>
7+
/// Developers specifiy the type name of this marker class to the <see cref="IElementConfiguration{TElement}.On{T}" /> method to specify the underlying Android control on which to run a platform-specific effect.
8+
/// </remarks>
59
public sealed class Android : IConfigPlatform { }
6-
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/iOS.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.iOS']/Docs/*" />
10+
11+
/// <summary>
12+
/// Marker class that identifies the iOS platform.
13+
/// </summary>
14+
/// <remarks>
15+
/// Developers specify the type name of this marker class to the <see cref = "IElementConfiguration{TElement}.On{T}" /> method to specify the underlying iOS control on which to run a platform-specific effect.
16+
/// </remarks>
717
public sealed class iOS : IConfigPlatform { }
8-
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/Windows.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.Windows']/Docs/*" />
18+
19+
/// <summary>
20+
/// Marker class that identifies the Windows platform.
21+
/// </summary>
22+
/// <remarks>
23+
/// Developers specify the type name of this marker class to the <see cref = "IElementConfiguration{TElement}.On{T}" /> method to specify the underlying Windows control on which to run a platform-specific effect.
24+
/// </remarks>
925
public sealed class Windows : IConfigPlatform { }
10-
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/Tizen.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.Tizen']/Docs/*" />
26+
27+
/// <summary>
28+
/// Marker class that identifies the Tizen platform.
29+
/// </summary>
30+
/// <remarks>
31+
/// Developers specify the type name of this marker class to the <see cref = "IElementConfiguration{TElement}.On{T}" /> method to specify the underlying Tizen control on which to run a platform-specific effect.
32+
/// </remarks>
1133
public sealed class Tizen : IConfigPlatform { }
12-
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/macOS.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.macOS']/Docs/*" />
34+
35+
/// <summary>
36+
/// Marker class that identifies the macOS platform.
37+
/// </summary>
38+
/// <remarks>
39+
/// Developers specify the type name of this marker class to the <see cref = "IElementConfiguration{TElement}.On{T}" /> method to specify the underlying macOS control on which to run a platform-specific effect.
40+
/// </remarks>
1341
public sealed class macOS : IConfigPlatform { }
14-
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/GTK.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.GTK']/Docs/*" />
42+
43+
/// <summary>
44+
/// Marker class that identifies the Linux platform.
45+
/// </summary>
46+
/// /// <remarks>
47+
/// Developers specify the type name of this marker class to the <see cref = "IElementConfiguration{TElement}.On{T}" /> method to specify the underlying GTK control on which to run a platform-specific effect.
48+
/// </remarks>
1549
public sealed class GTK : IConfigPlatform { }
1650
}

0 commit comments

Comments
 (0)