Skip to main content

Module doc_comment

Module doc_comment 

Source
Expand description

JSDoc-style doc comments.

Structs§

DocCapability
DocCapabilityBinding
DocCapabilityDiagnostic
DocComment
DocParam
DocReturns
DocText
DocUnknownTag
RawDoc
Delimiters /** and */ are included; span covers both.

Enums§

DocCapabilityBindingKind
DocCapabilityLiteral

Functions§

doc
Build a DocComment from a literal that has no real source range — file names its logical home (e.g. FileId::PRELUDE or a stdlib id).
parse_doc_comment