Class PublicApi

Namespace

Oqtane.Documentation

Assembly

Oqtane.Shared.dll

This attribute marks classes, properties etc. as public APIs. Any API / code with this attribute will be published in the docs. You can apply it to anything, but usually you will only need it on classes.

If you attach this attribute to a class like this:

[PublicApi]
public class YourClass {

}

or like this

[PublicApi("This is stable code")]
public class YourClass {

}

It will result in this class, method etc. to be publicly documented in the docs.oqtane.org.

If you want the entire class to be documented, just add this to the class. To exclude certain methods or properties add a PrivateApi, InternalApi or WorkInProgress attribute.

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

Inheritance

object

Attribute

PublicApi

Constructors

PublicApi()

The [PublicApi] attribute can usually be used without additional comment.

public PublicApi()

PublicApi(string)

Constructor with optional comment [PublicApi(some-comment)]

public PublicApi(string comment)

Parameters

comment string

Reason why it's public, optional