Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.
(documentation parameter-information)
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
Returns: string | MarkdownString | undefined
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted. **Returns:** `string | MarkdownString | undefined`
(label parameter-information)
The label of this signature.
Either a string or inclusive start and exclusive end offsets within its containing {@link SignatureInformation.label signature label}. Note: A label of type string must be a substring of its containing signature information's {@link SignatureInformation.label label}.
Returns: string | [number, number]
The label of this signature. Either a string or inclusive start and exclusive end offsets within its containing {@link SignatureInformation.label signature label}. *Note*: A label of type string must be a substring of its containing signature information's {@link SignatureInformation.label label}. **Returns:** `string | [number, number]`
(set-documentation! parameter-information value)
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.
(set-label! parameter-information value)
The label of this signature.
Either a string or inclusive start and exclusive end offsets within its containing {@link SignatureInformation.label signature label}. Note: A label of type string must be a substring of its containing signature information's {@link SignatureInformation.label label}.
The label of this signature. Either a string or inclusive start and exclusive end offsets within its containing {@link SignatureInformation.label signature label}. *Note*: A label of type string must be a substring of its containing signature information's {@link SignatureInformation.label label}.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close