Class WorkInProgressApi

Namespace

Oqtane.Documentation

Assembly

Oqtane.Shared.dll

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

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

Inheritance

object

Attribute

WorkInProgressApi

Constructors

WorkInProgressApi(string)

The [WorkInProgressApi(some-comment)] attributes must always have a comment why they are WIP.

public WorkInProgressApi(string comment)

Parameters

comment string

Reason why it's WIP, required