| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Language.Drasil.GOOL
Description
Re-export code-related smart constructors for external code writing and generation.
Synopsis
- class AuxiliarySym r where
- doxConfig :: String -> SoftwareDossierState -> Verbosity -> r FileAndContents
- readMe :: ReadMeInfo -> r FileAndContents
- optimizeDox :: r Doc
- makefile :: [FilePath] -> ImplementationType -> [Comments] -> SoftwareDossierState -> ProgData -> r FileAndContents
- auxHelperDoc :: r Doc -> Doc
- package :: Monad r => ProgData -> [r FileAndContents] -> r (PackageData ProgData)
- data FileAndContents
- data PackageData a
- unPP :: PythonProject a -> a
- unJP :: JavaProject a -> a
- unCSP :: CSharpProject a -> a
- unCPPP :: CppProject a -> a
- unSP :: SwiftProject a -> a
- unJLP :: JuliaProject a -> a
Documentation
class AuxiliarySym 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 #
auxHelperDoc :: r Doc -> Doc Source #
package :: Monad r => ProgData -> [r FileAndContents] -> r (PackageData ProgData) Source #
data FileAndContents Source #
The underlying data type for auxiliary files in all renderers.
data PackageData a Source #
The underlying data type for packages in all renderers.