AdditionalParameterPropertiesTransformer

Transformer that appends documentation to parameters indicating additional properties, such as:

  • whether the parameter is optional

Constructors

Link copied to clipboard
constructor(context: DokkaContext)

Types

Link copied to clipboard
data class ParameterProperties(val isOptional: Boolean, val isLikelyNamed: Boolean, val isLikelyBody: Boolean)

Additional properties of a parameter that can be documented.

Properties

Link copied to clipboard
val context: DokkaContext

Functions

Link copied to clipboard
open operator override fun invoke(modules: List<DModule>): List<DModule>