quarkdown-quarkdoc-reader/com.quarkdown.quarkdoc.reader.anchors/Anchors

Anchors

Anchors are flag elements that can be used to mark specific sections of documentation. Anchors are generated by Quarkdoc, and read by Quarkdoc-Reader to extract specific information.

Properties

LIKELY_BODY

const val LIKELY_BODY: String

Name of the anchor for likely body parameters.

LIKELY_CHAINED

const val LIKELY_CHAINED: String

Name of the anchor for likely chained functions.

LIKELY_NAMED

const val LIKELY_NAMED: String

Name of the anchor for likely named parameters.

OPTIONAL

const val OPTIONAL: String

Name of the anchor for optional parameters.

VALUES

const val VALUES: String

Name of the anchor for optionally present enum values of a parameter.