Class WorkInProgressApi

Namespace

ToSic.Sys.Documentation

Assembly

ToSic.Sys.Core.dll

This attribute marks APIs to be publicly documented with a clear warning that it's work in progress.

[InternalApi_DoNotUse_MayChangeWithoutNotice]
[AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = false)]
public class WorkInProgressApi : Attribute

Inheritance

object

Attribute

WorkInProgressApi

Remarks

Constructor. WIP attributes must always have a comment why they are WIP.

Constructors

WorkInProgressApi(string)

This attribute marks APIs to be publicly documented with a clear warning that it's work in progress.

public WorkInProgressApi(string comment)

Parameters

comment string

Reason why it's WIP, required

Remarks

Constructor. WIP attributes must always have a comment why they are WIP.