| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Drasil.System
Synopsis
- type Purpose = [Sentence]
- type Background = [Sentence]
- type Scope = [Sentence]
- type Motivation = [Sentence]
- data SystemMeta
- class HasSystemMeta c where
- systemMeta :: Lens' c SystemMeta
- authors :: Lens' c People
- background :: Lens' c Background
- motivation :: Lens' c Motivation
- purpose :: Lens' c Purpose
- scope :: Lens' c Scope
- sysName :: Lens' c CI
- systemdb :: Lens' c ChunkDB
- mkSystemMeta :: CI -> People -> Purpose -> Background -> Scope -> Motivation -> ChunkDB -> SystemMeta
- class HasSystemMeta sys => ToFiles sys opts | opts -> sys where
- toFiles :: sys -> opts -> [FileLayout]
Documentation
type Background = [Sentence] Source #
Project Example background information, used in the What section of
README.
type Motivation = [Sentence] Source #
Project Example motivation.
data SystemMeta Source #
Instances
| HasSystemMeta SystemMeta Source # | |
Defined in Drasil.System.Core Methods systemMeta :: Lens' SystemMeta SystemMeta Source # authors :: Lens' SystemMeta People Source # background :: Lens' SystemMeta Background Source # motivation :: Lens' SystemMeta Motivation Source # purpose :: Lens' SystemMeta Purpose Source # scope :: Lens' SystemMeta Scope Source # sysName :: Lens' SystemMeta CI Source # systemdb :: Lens' SystemMeta ChunkDB Source # | |
class HasSystemMeta c where Source #
Minimal complete definition
Methods
systemMeta :: Lens' c SystemMeta Source #
authors :: Lens' c People Source #
background :: Lens' c Background Source #
motivation :: Lens' c Motivation Source #
purpose :: Lens' c Purpose Source #
scope :: Lens' c Scope Source #
Instances
| HasSystemMeta SystemMeta Source # | |
Defined in Drasil.System.Core Methods systemMeta :: Lens' SystemMeta SystemMeta Source # authors :: Lens' SystemMeta People Source # background :: Lens' SystemMeta Background Source # motivation :: Lens' SystemMeta Motivation Source # purpose :: Lens' SystemMeta Purpose Source # scope :: Lens' SystemMeta Scope Source # sysName :: Lens' SystemMeta CI Source # systemdb :: Lens' SystemMeta ChunkDB Source # | |
mkSystemMeta :: CI -> People -> Purpose -> Background -> Scope -> Motivation -> ChunkDB -> SystemMeta Source #
class HasSystemMeta sys => ToFiles sys opts | opts -> sys where Source #
The goal of our systems is to be abstractions about human-readable software
artifacts. An instance of this typeclass (ToFiles) defines a software
generator that explains how said abstractions can be made fully concrete
(i.e., made into concrete software artifacts).
Methods
Arguments
| :: sys | The system. |
| -> opts | The generation options. |
| -> [FileLayout] | The final, rendered software artifacts. |