Logo FSharp.Formatting

ApiDocParameter Type

Represents a parameter of an API member, with its symbol, name, type, and optional documentation

Record fields

Record Field Description

ParameterDocs

Full Usage: ParameterDocs

Field type: ApiDocHtml option

Optional documentation for the parameter

Field type: ApiDocHtml option

ParameterNameText

Full Usage: ParameterNameText

Field type: string

The parameter name as text

Field type: string

ParameterSymbol

Full Usage: ParameterSymbol

Field type: Choice<FSharpParameter, FSharpField>

The FSharp symbol for the parameter (either a parameter or a record field)

Field type: Choice<FSharpParameter, FSharpField>

ParameterType

Full Usage: ParameterType

Field type: ApiDocHtml

The formatted HTML type of the parameter

Field type: ApiDocHtml

Type something to start searching.