elvdoc

Documentation

Overview

Package elvdoc extracts doc comments of Elvish variables and functions.

Index

• func ExtractAllFromFS(fsys fs.FS) (map[string]Docs, error)
• func HighlightCodeBlock(info, code string) ui.Text
• type Docs
  • func Extract(r io.Reader, symbolPrefix string) (Docs, error)
  • func ExtractFromFS(fsys fs.FS, symbolPrefix string) (Docs, error)
• type Entry

Functions

func ExtractAllFromFS

func ExtractAllFromFS(fsys fs.FS) (map[string]Docs, error)

ExtractFS extracts elvdocs of all modules found under fsys, and returns a map from the symbol prefix of a module ("" for builtin, "$mod:" for any other $mod).

See ExtractFromFS for how modules correspond to files.

func HighlightCodeBlock

func HighlightCodeBlock(info, code string) ui.Text

HighlightCodeBlock highlights a code block from Markdown. It handles thea elvish and elvish-transcript languages.

Types

type Docs

type Docs struct {
	Fns  []Entry
	Vars []Entry
}

Docs records doc comments.

func Extract

func Extract(r io.Reader, symbolPrefix string) (Docs, error)

Extract extracts the elvdoc of one module from an Elvish source.

func ExtractFromFS

func ExtractFromFS(fsys fs.FS, symbolPrefix string) (Docs, error)

ExtractFromFS extracts elvdoc of a module from fsys. The symbolPrefix is used to look up which files to read:

• "": eval/*.elv (the builtin module)
• "edit:": edit/*.elv
• "$mod:": mods/$symbolPrefix/*.elv

If symbolPrefix is not empty and doesn't end in ":", this function panics.

type Entry

type Entry struct {
	Name string
	// ID to use in HTML
	ID      string
	Content string
}

Entry is a doc comment entry.