Add Documentation attributes

part of https://github.com/oqtane/oqtane.framework/issues/570
This commit is contained in:
ijungleboy
2020-10-15 10:38:25 +02:00
parent 81475fd835
commit 06c041dd4e
5 changed files with 107 additions and 0 deletions

View File

@ -0,0 +1,18 @@
using System;
namespace Oqtane.Documentation
{
/// <summary>
/// This attribute marks APIs to be publicly documented with a clear warning that it's work in progress.
/// </summary>
[AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = false)]
[PublicApi]
public class WorkInProgressApi: Attribute
{
/// <summary>
/// The `[WorkInProgressApi(some-comment)]` attributes must always have a comment why they are WIP.
/// </summary>
/// <param name="comment">Reason why it's WIP, required</param>
public WorkInProgressApi(string comment) { }
}
}