Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate xml docs directly into code for ExtensionPoints #24333

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Migrate xml docs directly into code for ExtensionPoints #24333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f76f708
Move android platform documentation out of XML file
Aug 20, 2024
8a31ab9
move other platform api docs into ExtensionPoints
Aug 20, 2024
e120008
Fix feedback
jfversluis Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/Android.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Marker class that identifies the Android platform.</summary>
<remarks>
<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>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Android ();" />
Expand Down
6 changes: 0 additions & 6 deletions src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/Tizen.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Marker class that identifies the Tizen platform.</summary>
<remarks>
<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>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Tizen ();" />
Expand Down
6 changes: 0 additions & 6 deletions src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/Windows.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Marker class that identifies the Windows platform.</summary>
<remarks>
<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>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Windows ();" />
Expand Down
6 changes: 0 additions & 6 deletions src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/iOS.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Marker class that identifies the iOS platform.</summary>
<remarks>
<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>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public iOS ();" />
Expand Down
4 changes: 0 additions & 4 deletions src/Controls/docs/Microsoft.Maui.Controls.PlatformConfiguration/macOS.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,6 @@
<InterfaceName>Microsoft.Maui.Controls.IConfigPlatform</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Marker class that identifies the macOS platform.</summary>
<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>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public macOS ();" />
Expand Down
48 changes: 41 additions & 7 deletions src/Controls/src/Core/PlatformConfiguration/ExtensionPoints.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,50 @@

namespace Microsoft.Maui.Controls.PlatformConfiguration
{
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/Android.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.Android']/Docs/*" />
/// <summary>
/// Marker class that identifies the Android platform.
/// </summary>
/// <remarks>
/// 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.
/// </remarks>
public sealed class Android : IConfigPlatform { }
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/iOS.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.iOS']/Docs/*" />

/// <summary>
/// Marker class that identifies the iOS platform.
/// </summary>
/// <remarks>
/// 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.
/// </remarks>
public sealed class iOS : IConfigPlatform { }
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/Windows.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.Windows']/Docs/*" />

/// <summary>
/// Marker class that identifies the Windows platform.
/// </summary>
/// <remarks>
/// 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.
/// </remarks>
public sealed class Windows : IConfigPlatform { }
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/Tizen.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.Tizen']/Docs/*" />

/// <summary>
/// Marker class that identifies the Tizen platform.
/// </summary>
/// <remarks>
/// 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.
/// </remarks>
public sealed class Tizen : IConfigPlatform { }
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/macOS.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.macOS']/Docs/*" />

/// <summary>
/// Marker class that identifies the macOS platform.
/// </summary>
/// <remarks>
/// 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.
/// </remarks>
public sealed class macOS : IConfigPlatform { }
/// <include file="../../../docs/Microsoft.Maui.Controls.PlatformConfiguration/GTK.xml" path="Type[@FullName='Microsoft.Maui.Controls.PlatformConfiguration.GTK']/Docs/*" />

/// <summary>
/// Marker class that identifies the Linux platform.
/// </summary>
/// /// <remarks>
/// 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.
/// </remarks>
public sealed class GTK : IConfigPlatform { }
}
Loading