Class PrivateApi

Namespace

Oqtane.Documentation

Assembly

Oqtane.Shared.dll

This attribute marks classes, methods, etc. as private APIs So they should not be publicly documented. By default, all APIs are private, so you only need this attribute on children of classes marked with [PublicApi].

If you attach this attribute to a class like this:

[PrivateApi]
public class YourClass {

}

or like this

[PrivateApi("Reason why the API should remain private")]
public class YourClass {

}

or in combination with PublicApi

[PublicApi]
public class YourClass {
	public string Name;

	[PrivateApi("Don't publish this - should only be used internally")]
	public string InternalSpecialName;
}

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

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

Inheritance

object

Attribute

PrivateApi

Constructors

PrivateApi()

The [PrivateApi] attribute can be used without additional comment.

public PrivateApi()

PrivateApi(string)

Constructor with optional comment [PrivateApi(some-comment)].

public PrivateApi(string comment)

Parameters

comment string

Reason why it's private, optional