scion-browser-0.2.16: Command-line interface for browsing and searching packages documentation

Safe HaskellNone

Scion.PersistentBrowser

Synopsis

Documentation

data Doc Source

Documentation for an item. Now it is simply a Text element.

Constructors

NoDoc 
Doc Text 

Instances

type Documented a = a DocSource

A documented item.

data Package l Source

A package.

Instances

Show l => Show (Package l) 
Package (Package l) 

type Database = Map PackageIdentifier (Documented Package)Source

A Database saves a list of packages.

getNameString :: Name l -> StringSource

Gets the name inside a Name constructor.

getQNameString :: QName l -> StringSource

Gets the qualified name as a string.

class Annotated e => Named e whereSource

Methods

getName :: Show l => e l -> StringSource

class (Named parent, Named child) => DocItem parent child | parent -> child whereSource

Methods

getChildren :: Show l => parent l -> [child l]Source

getChild :: Show l => parent l -> String -> Maybe (child l)Source

data DbTyVarGeneric backend Source

Constructors

DbTyVar 

Fields

dbTyVarName :: !String
 
dbTyVarDeclId :: !(KeyBackend backend (DbDeclGeneric backend))
 

data DbCompleteDecl Source

Complete information for a declaration. Look at its ToJSON instance to know which one is used in each kind of declaration.