Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Drasil.SoftwareDossier.SoftwareDossierSym

Description

Defines a package extension for GOOL, with the relevant slice of GOOLState and functions for pairing a GOOL program with "Software Dossier" (i.e. non-source-code) files.

Synopsis

data SoftwareDossierState
makeSds :: [FilePath] -> [FilePath] -> Maybe FilePath -> SoftwareDossierState
headers :: Lens' SoftwareDossierState [FilePath]
sources :: Lens' SoftwareDossierState [FilePath]
mainMod :: Lens' SoftwareDossierState (Maybe FilePath)
class SoftwareDossierSym r where
- doxConfig :: String -> SoftwareDossierState -> Verbosity -> r FileAndContents
- readMe :: ReadMeInfo -> r FileAndContents
- optimizeDox :: r Doc
- makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> r FileAndContents
- unReprDoc :: r Doc -> Doc
sampleInput :: Applicative r => PrintingInformation -> DataDesc -> [Expr] -> r FileAndContents
sdsFromData :: Applicative r => FilePath -> Doc -> r FileAndContents

Documentation

data SoftwareDossierState Source #

makeSds :: [FilePath] -> [FilePath] -> Maybe FilePath -> SoftwareDossierState Source #

headers :: Lens' SoftwareDossierState [FilePath] Source #

sources :: Lens' SoftwareDossierState [FilePath] Source #

mainMod :: Lens' SoftwareDossierState (Maybe FilePath) Source #

class SoftwareDossierSym r where Source #

Members of this class must have a doxygen configuration, ReadMe file, omptimize doxygen document, information necessary for a makefile, and auxiliary helper documents

Methods

doxConfig :: String -> SoftwareDossierState -> Verbosity -> r FileAndContents Source #

readMe :: ReadMeInfo -> r FileAndContents Source #

optimizeDox :: r Doc Source #

makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> r FileAndContents Source #

unReprDoc :: r Doc -> Doc Source #

Instances

Instances details

SoftwareDossierSym CSharpProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.CSharpRenderer Methods doxConfig :: String -> SoftwareDossierState -> Verbosity -> CSharpProject FileAndContents Source # readMe :: ReadMeInfo -> CSharpProject FileAndContents Source # optimizeDox :: CSharpProject Doc Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> CSharpProject FileAndContents Source # unReprDoc :: CSharpProject Doc -> Doc Source #
SoftwareDossierSym CppProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.CppRenderer Methods doxConfig :: String -> SoftwareDossierState -> Verbosity -> CppProject FileAndContents Source # readMe :: ReadMeInfo -> CppProject FileAndContents Source # optimizeDox :: CppProject Doc Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> CppProject FileAndContents Source # unReprDoc :: CppProject Doc -> Doc Source #
SoftwareDossierSym JavaProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.JavaRenderer Methods doxConfig :: String -> SoftwareDossierState -> Verbosity -> JavaProject FileAndContents Source # readMe :: ReadMeInfo -> JavaProject FileAndContents Source # optimizeDox :: JavaProject Doc Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> JavaProject FileAndContents Source # unReprDoc :: JavaProject Doc -> Doc Source #
SoftwareDossierSym JuliaProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.JuliaRenderer Methods doxConfig :: String -> SoftwareDossierState -> Verbosity -> JuliaProject FileAndContents Source # readMe :: ReadMeInfo -> JuliaProject FileAndContents Source # optimizeDox :: JuliaProject Doc Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> JuliaProject FileAndContents Source # unReprDoc :: JuliaProject Doc -> Doc Source #
SoftwareDossierSym PythonProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.PythonRenderer Methods doxConfig :: String -> SoftwareDossierState -> Verbosity -> PythonProject FileAndContents Source # readMe :: ReadMeInfo -> PythonProject FileAndContents Source # optimizeDox :: PythonProject Doc Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> PythonProject FileAndContents Source # unReprDoc :: PythonProject Doc -> Doc Source #
SoftwareDossierSym SwiftProject Source #
Instance details Defined in Language.Drasil.Code.Imperative.GOOL.LanguageRenderer.SwiftRenderer Methods doxConfig :: String -> SoftwareDossierState -> Verbosity -> SwiftProject FileAndContents Source # readMe :: ReadMeInfo -> SwiftProject FileAndContents Source # optimizeDox :: SwiftProject Doc Source # makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> SwiftProject FileAndContents Source # unReprDoc :: SwiftProject Doc -> Doc Source #

sampleInput :: Applicative r => PrintingInformation -> DataDesc -> [Expr] -> r FileAndContents Source #

sdsFromData :: Applicative r => FilePath -> Doc -> r FileAndContents Source #