pub type DocBlock {
  DocBlock(
    lines: List(String),
    target: option.Option(String),
    file: String,
    start_line: Int,
    public_names: List(String),
    module_imports: List(String),
  )
}

Constructors

• DocBlock(
    lines: List(String),
    target: option.Option(String),
    file: String,
    start_line: Int,
    public_names: List(String),
    module_imports: List(String),
  )

  Arguments

  lines

  The doc comment lines with the /// prefix stripped and whitespace trimmed.

  target

  The name of the definition this doc comment precedes, if any.

  file

  The file path the doc block was extracted from.

  start_line

  The 1-based line number where the doc block starts.

  public_names

  Public names exported by the source file (functions, types, constants).

  module_imports

  Top-level imports of the source file, formatted as import strings.