idris-0.9.16: Functional Programming Language with Dependent Types

Safe HaskellNone
LanguageHaskell98

Idris.Docs

Synopsis

Documentation

pprintDocs :: IState -> Docs -> Doc OutputAnnotation Source

getDocs :: Name -> Idris Docs Source

Given a fully-qualified, disambiguated name, construct the documentation object for it

pprintConstDocs :: IState -> Const -> String -> Doc OutputAnnotation Source

data FunDoc Source

Constructors

FD Name (Docstring DocTerm) [(Name, PTerm, Plicity, Maybe (Docstring DocTerm))] PTerm (Maybe Fixity) 

data Docs Source

Constructors

FunDoc FunDoc 
DataDoc FunDoc [FunDoc] 
ClassDoc Name (Docstring DocTerm) [FunDoc] [(Name, Maybe (Docstring DocTerm))] [PTerm] [PTerm] 
ModDoc [String] (Docstring DocTerm)