Skip to content

Commit

Permalink
refactor: Improve documentation of NotImplementedAttribute
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromelaban committed Sep 1, 2020
1 parent 691a671 commit 80fc4e9
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/Uno.Foundation/NotImplementedAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,29 @@

namespace Uno
{
/// <summary>
/// Marks a member or symbol as not implemented by Uno.
/// </summary>
[System.AttributeUsage(AttributeTargets.All, Inherited = false, AllowMultiple = false)]
public sealed class NotImplementedAttribute : Attribute
{
/// <summary>
/// Creates an instance
/// </summary>
public NotImplementedAttribute() { }

/// <summary>
/// Creates an instance with C# constants for which the symbol is not implemented.
/// </summary>
/// <param name="platforms">The list of not-implemented platforms</param>
public NotImplementedAttribute(params string[] platforms)
{
Platforms = platforms;
}

/// <summary>
/// The list of platforms that are not implemented. When empty, all platforms are not implemented.
/// </summary>
public string[]? Platforms { get; }
}
}

0 comments on commit 80fc4e9

Please sign in to comment.