DocsParameter

data class DocsParameter(val name: String, val description: String, val isOptional: Boolean, val isLikelyNamed: Boolean, val isLikelyBody: Boolean)

A function parameter in a documentation file.

Parameters

name

the name of the parameter

description

the description of the parameter, possibly in HTML format

isOptional

whether the parameter is optional

isLikelyNamed

whether the parameter is likely to be passed as a named parameter

isLikelyBody

whether the parameter is likely to be passed as a body parameter

Constructors

Link copied to clipboard
constructor(name: String, description: String, isOptional: Boolean, isLikelyNamed: Boolean, isLikelyBody: Boolean)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard