quarkdown-quarkdoc/com.quarkdown.quarkdoc.dokka.transformers.misc/DocumentTypeConstraintsTransformer

DocumentTypeConstraintsTransformer

object DocumentTypeConstraintsTransformer

Given a function annotated with @OnlyForDocumentType or @NotForDocumentType which defines constraints about the document type the function supports, these transformer add a DocumentTargetProperty extra property.

See also

Types

Link copied to clipboard
abstract class AbstractTransformer(annotationTypesParameterProperty: KProperty<Array<out DocumentType>>, context: DokkaContext) : QuarkdocDocumentableReplacerTransformer

Base class for transformers that specify document type constraints to DFunctions, retrieved from annotations in the function declaration. If type constraints are present, the supported document types are stored in the function's extra properties as DocumentTargetProperty.

Link copied to clipboard
class Negative(context: DokkaContext) : DocumentTypeConstraintsTransformer.AbstractTransformer

Given a function annotated with @NotForDocumentType(X), this transformer sets the function's constraint to all document types except X.

Link copied to clipboard
class Positive(context: DokkaContext) : DocumentTypeConstraintsTransformer.AbstractTransformer

Given a function annotated with @OnlyForDocumentType(X), this transformer sets the function's constraint to only the document type X.