DocIndex

struct DocIndex

The result of joining scanner comment spans to parser declaration spans.

entries is sorted by declaration position and contains only leading, contiguous line-comment groups. Trailing comments, groups separated by a blank line, pragmas, and comments without a following declaration are orphans.

Properties

let entries: [DocumentedDecl]

Successfully attached declaration/comment groups in declaration order.

let orphans: [Comment]

Comments that attached to nothing: trailing, blank-line separated, or stranded with no decl below them.