quarkdown-core/com.quarkdown.core.function.reflect.annotation

Package-level declarations

Types

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class Injected

When a library function parameter is annotated with @Injected, its value is not supplied by a function call but rather automatically injected by com.quarkdown.core.function.call.binding.InjectedArgumentsBinder.

LikelyBody

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class LikelyBody

When a library function parameter is annotated with @LikelyBody, it is marked as a body parameter that usually expects a body argument (wiki). This does not have any runtime effect, but is rather used for documentation purposes (see Quarkdoc).

LikelyChained

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class LikelyChained

When a library function is annotated with @LikelyChained, it is marked as a parameter that usually expects to be chained (wiki). This does not have any runtime effect, but is rather used for documentation purposes (see Quarkdoc).

LikelyNamed

@Target(allowedTargets = [AnnotationTarget.VALUE_PARAMETER])

annotation class LikelyNamed

When a library function parameter is annotated with @LikelyNamed, it is marked as a parameter that usually expects a named argument (wiki). This does not have any runtime effect, but is rather used for documentation purposes (see Quarkdoc).

Name

@Target(allowedTargets = [AnnotationTarget.FUNCTION, AnnotationTarget.VALUE_PARAMETER])

annotation class Name(val name: String)

If a library member is annotated with this, a custom name is set instead of its original name. For example:

NoAutoArgumentUnwrapping

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class NoAutoArgumentUnwrapping

When invoking a function via KFunctionAdapter, Value arguments are automatically unwrapped to their raw value, unless this annotation is present on the Value subclass.

NotForDocumentType

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class NotForDocumentType(val types: DocumentType)

When a library function is annotated with this annotation, it can only be called if the document adopts none of the given document types. This is the opposite of OnlyForDocumentType.

OnlyForDocumentType

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class OnlyForDocumentType(val types: DocumentType)

When a library function is annotated with this annotation, it can only be called if the document adopts one of the given document types.

Functions

toValidator

fun <T : OutputValue<*>> NotForDocumentType.toValidator(): DocumentTypeFunctionCallValidator<T>

Converts an NotForDocumentType annotation to a DocumentTypeFunctionCallValidator

fun <T : OutputValue<*>> OnlyForDocumentType.toValidator(): DocumentTypeFunctionCallValidator<T>

Converts an OnlyForDocumentType annotation to a DocumentTypeFunctionCallValidator