Safe Haskell | Safe-Infered |
---|
- data Doc
- docFromString :: String -> Doc
- type Documented a = a Doc
- data Package l = Package l PackageIdentifier (Map String (Documented Module))
- type Database = Map PackageIdentifier (Documented Package)
- getNameString :: Name l -> String
- getQNameString :: QName l -> String
- class Annotated e => Named e where
- class (Named parent, Named child) => DocItem parent child | parent -> child where
- data DbDeclType
- = DbData
- | DbNewType
- | DbClass
- | DbInstance
- | DbSignature
- | DbType
- data DbPackageGeneric backend = DbPackage {}
- type DbPackage = DbPackageGeneric SqlPersist
- type DbPackageId = Key SqlPersist DbPackage
- data DbModuleGeneric backend = DbModule {
- dbModuleName :: String
- dbModuleDoc :: Maybe String
- dbModulePackageId :: Key backend (DbPackageGeneric backend)
- type DbModule = DbModuleGeneric SqlPersist
- type DbModuleId = Key SqlPersist DbModule
- data DbDeclGeneric backend = DbDecl {
- dbDeclDeclType :: DbDeclType
- dbDeclName :: String
- dbDeclDoc :: Maybe String
- dbDeclKind :: Maybe String
- dbDeclSignature :: Maybe String
- dbDeclEquals :: Maybe String
- dbDeclModuleId :: Key backend (DbModuleGeneric backend)
- type DbDecl = DbDeclGeneric SqlPersist
- type DbDeclId = Key SqlPersist DbDecl
- data DbTyVarGeneric backend = DbTyVar {
- dbTyVarName :: String
- dbTyVarDeclId :: Key backend (DbDeclGeneric backend)
- type DbTyVar = DbTyVarGeneric SqlPersist
- type DbTyVarId = Key SqlPersist DbTyVar
- data DbFunDepGeneric backend = DbFunDep {
- dbFunDepName :: String
- dbFunDepDeclId :: Key backend (DbDeclGeneric backend)
- type DbFunDep = DbFunDepGeneric SqlPersist
- type DbFunDepId = Key SqlPersist DbFunDep
- data DbContextGeneric backend = DbContext {
- dbContextShown :: String
- dbContextDeclId :: Key backend (DbDeclGeneric backend)
- type DbContext = DbContextGeneric SqlPersist
- type DbContextId = Key SqlPersist DbContext
- data DbConstructorGeneric backend = DbConstructor {
- dbConstructorName :: String
- dbConstructorSignature :: String
- dbConstructorDeclId :: Key backend (DbDeclGeneric backend)
- type DbConstructor = DbConstructorGeneric SqlPersist
- type DbConstructorId = Key SqlPersist DbConstructor
- migrateAll :: forall m. (MonadBaseControl IO m, MonadIO m) => Migration (SqlPersist m)
- data DbPackageIdentifier = DbPackageIdentifier String String
- dbPackageToIdentifier :: DbPackage -> DbPackageIdentifier
- data DbCompleteDecl = DbCompleteDecl DbDecl [DbContext] [DbTyVar] [DbFunDep] [DbConstructor]
Documentation
docFromString :: String -> DocSource
type Documented a = a DocSource
A documented item.
A package.
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 (Named parent, Named child) => DocItem parent child | parent -> child whereSource
data DbDeclType Source
data DbPackageGeneric backend Source
ToJSON DbPackage | |
HasDbPackage DbPackage | |
PersistField (DbPackageGeneric backend) | |
PersistEntity (DbPackageGeneric backend) |
type DbPackageId = Key SqlPersist DbPackageSource
data DbModuleGeneric backend Source
DbModule | |
|
ToJSON DbModule | |
HasDbModule DbModule | |
HasDbPackage DbModule | |
PersistField (DbModuleGeneric backend) | |
PersistEntity (DbModuleGeneric backend) |
type DbModuleId = Key SqlPersist DbModuleSource
data DbDeclGeneric backend Source
DbDecl | |
|
HasDbModule DbDecl | |
HasDbPackage DbDecl | |
PersistField (DbDeclGeneric backend) | |
PersistEntity (DbDeclGeneric backend) |
type DbDecl = DbDeclGeneric SqlPersistSource
type DbDeclId = Key SqlPersist DbDeclSource
data DbTyVarGeneric backend Source
DbTyVar | |
|
ToJSON DbTyVar | |
PersistField (DbTyVarGeneric backend) | |
PersistEntity (DbTyVarGeneric backend) |
type DbTyVarId = Key SqlPersist DbTyVarSource
data DbFunDepGeneric backend Source
DbFunDep | |
|
ToJSON DbFunDep | |
PersistField (DbFunDepGeneric backend) | |
PersistEntity (DbFunDepGeneric backend) |
type DbFunDepId = Key SqlPersist DbFunDepSource
data DbContextGeneric backend Source
DbContext | |
|
ToJSON DbContext | |
PersistField (DbContextGeneric backend) | |
PersistEntity (DbContextGeneric backend) |
type DbContextId = Key SqlPersist DbContextSource
data DbConstructorGeneric backend Source
DbConstructor | |
|
ToJSON DbConstructor | |
HasDbModule DbConstructor | |
PersistField (DbConstructorGeneric backend) | |
PersistEntity (DbConstructorGeneric backend) |
migrateAll :: forall m. (MonadBaseControl IO m, MonadIO m) => Migration (SqlPersist m)Source
data DbPackageIdentifier Source
Information needed to search a package.
data DbCompleteDecl Source
Complete information for a declaration. Look at its ToJSON instance to know which one is used in each kind of declaration.