Table of Contents

Namespace ToSic.Lib.Documentation

Classes

DocumentationPlaceholder

This is a placeholder class, to make sure the namespace is included in the documentation. It is used in namespaces where there are no public classes.

InternalApi_DoNotUse_MayChangeWithoutNotice

This attribute serves as metadata for other things to mark them as internal APIs. Use this on objects/properties/methods you want to document publicly for example to improve understanding of the system - but still mark as internal so people are warned

PrivateApi

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

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.