Copyright	(c) 2013-2025 Galois Inc.
License	BSD3
Maintainer	cryptol@galois.com
Stability	provisional
Portability	portable
Safe Haskell	Safe
Language	Haskell2010

Cryptol.TypeCheck.Docstrings

Description

Synopsis

data DocItem = DocItem {
- docModContext :: ImpName Name
- docFor :: DocFor
- docText :: [Text]
}
data DocFor
- = DocForMod (ImpName Name)
- | DocForDef Name
gatherModuleDocstrings :: Map Name (ImpName Name) -> Module -> [DocItem]
extractCodeBlocks :: Text -> [[Text]]

Documentation

data DocItem Source #

Constructors

DocItem
Fields docModContext :: ImpName Name The module scope to run repl commands in docFor :: DocFor The name the documentation is attached to docText :: [Text] The text of the attached docstring, if any

data DocFor Source #

Constructors

DocForMod (ImpName Name)
DocForDef Name

Instances

Instances details

PP DocFor Source #
Instance details Defined in Cryptol.TypeCheck.Docstrings Methods ppPrec :: Int -> DocFor -> Doc Source # ppPrecWithAnnot :: [([Int], PPAnnot)] -> Int -> DocFor -> Doc Source #

gatherModuleDocstrings :: Map Name (ImpName Name) -> Module -> [DocItem] Source #

extractCodeBlocks :: Text -> [[Text]] Source #

Extract the code blocks from the body of a docstring.

A single code block starts with at least 3 backticks followed by an optional language specifier of "cryptol". This allows other kinds of code blocks to be included (and ignored) in docstrings. Longer backtick sequences can be used when a code block needs to be able to contain backtick sequences.

/**
 * A docstring example
 *
 * ```cryptol
 * :check example
 * ```
 */