idris-0.9.18.1: Functional Programming Language with Dependent Types

Safe HaskellNone
LanguageHaskell98

Idris.Docs

Synopsis

Documentation

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

getDocs :: Name -> HowMuchDocs -> Idris Docs Source

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

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

type FunDoc = FunDoc' (Docstring DocTerm) Source

data FunDoc' d Source

Constructors

FD Name d [(Name, PTerm, Plicity, Maybe d)] PTerm (Maybe Fixity) 

Instances

Functor FunDoc' 

type Docs = Docs' (Docstring DocTerm) Source

data Docs' d Source

Constructors

FunDoc (FunDoc' d) 
DataDoc (FunDoc' d) [FunDoc' d] 
ClassDoc Name d [FunDoc' d] [(Name, Maybe d)] [(Maybe Name, PTerm, (d, [(Name, d)]))] [PTerm] [PTerm] (Maybe (FunDoc' d)) 
NamedInstanceDoc Name (FunDoc' d) 
ModDoc [String] d 

Instances

Functor Docs'