drasil-system-0.1.1.0: A framework for code and document generation for scientific software - System SubPackage
Safe HaskellSafe-Inferred
LanguageHaskell2010

Drasil.System.SmithEtAlSRS

Description

Define types and functions related to creating a system information database.

Synopsis

System

Types

data SmithEtAlSRS where Source #

Data structure for holding all of the requisite information about a system to be used in artifact generation.

Constructors

ICO 

Fields

type Purpose = [Sentence] Source #

Project Example purpose.

type Background = [Sentence] Source #

Project Example background information, used in the What section of README.

type Scope = [Sentence] Source #

Project Example scope.

type Motivation = [Sentence] Source #

Project Example motivation.

Lenses

class HasSmithEtAlSRS c where Source #

Minimal complete definition

smithEtAlSRS

Constructors

Hacks

refbyLookup :: UID -> SmithEtAlSRS -> [UID] Source #

Find what chunks reference a specific chunk.

traceLookup :: UID -> SmithEtAlSRS -> [UID] Source #

Find what chunks a specific one references.