gleedoc/extract

Types

DocBlock

</>

Represents an extracted doc comment block from a Gleam source file.

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

Constructors

```
DocBlock(
  lines: List(String),
  target: option.Option(String),
  file: String,
  start_line: Int,
)
```
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.

Values

doc_blocks_from_file

</>

pub fn doc_blocks_from_file(
  file_path: String,
) -> Result(List(DocBlock), snag.Snag)

Extract all doc comment blocks from a Gleam source file.

✨