Class PrivateApi

Namespace

ToSic.Lib.Documentation

Assembly

ToSic.Lib.Core.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] see PublicApi.

[PublicApi]
[AttributeUsage(AttributeTargets.All, AllowMultiple = true, Inherited = false)]
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