Safe Haskell	None
Language	Haskell2010

Test.DocTest.Internal.Extract

Synopsis

data Module a = Module {
- moduleName :: String
- moduleSetup :: Maybe a
- moduleContent :: [a]
- moduleConfig :: [Located String]
}
extract :: [String] -> IO [Module (Located String)]
eraseConfigLocation :: Module a -> Module a

Documentation

data Module a Source #

Documentation for a module grouped together with the modules name.

Constructors

Module
Fields moduleName :: String moduleSetup :: Maybe a moduleContent :: [a] moduleConfig :: [Located String]

Instances

Instances details

Functor Module Source #

Instance details

Defined in Test.DocTest.Internal.Extract

Methods

fmap :: (a -> b) -> Module a -> Module b #

(<$) :: a -> Module b -> Module a #

Generic (Module a) Source #

Instance details

Defined in Test.DocTest.Internal.Extract

Associated Types

type Rep (Module a)

Instance details

Defined in Test.DocTest.Internal.Extract

type Rep (Module a) = D1 ('MetaData "Module" "Test.DocTest.Internal.Extract" "doctest-parallel-0.3.1.1-9MYAEjo21b44k1f41cnDw1" 'False) (C1 ('MetaCons "Module" 'PrefixI 'True) ((S1 ('MetaSel ('Just "moduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "moduleSetup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))) :*: (S1 ('MetaSel ('Just "moduleContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: S1 ('MetaSel ('Just "moduleConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Located String]))))

Methods

from :: Module a -> Rep (Module a) x #

to :: Rep (Module a) x -> Module a #

Show a => Show (Module a) Source #

Instance details

Defined in Test.DocTest.Internal.Extract

Methods

showsPrec :: Int -> Module a -> ShowS #

show :: Module a -> String #

showList :: [Module a] -> ShowS #

NFData a => NFData (Module a) Source #

Instance details

Defined in Test.DocTest.Internal.Extract

Methods

rnf :: Module a -> () #

Eq a => Eq (Module a) Source #

Instance details

Defined in Test.DocTest.Internal.Extract

Methods

(==) :: Module a -> Module a -> Bool #

(/=) :: Module a -> Module a -> Bool #

type Rep (Module a) Source #

Instance details

Defined in Test.DocTest.Internal.Extract

type Rep (Module a) = D1 ('MetaData "Module" "Test.DocTest.Internal.Extract" "doctest-parallel-0.3.1.1-9MYAEjo21b44k1f41cnDw1" 'False) (C1 ('MetaCons "Module" 'PrefixI 'True) ((S1 ('MetaSel ('Just "moduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "moduleSetup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))) :*: (S1 ('MetaSel ('Just "moduleContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: S1 ('MetaSel ('Just "moduleConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Located String]))))

extract :: [String] -> IO [Module (Located String)] Source #

Extract all docstrings from given list of files/modules.

This includes the docstrings of all local modules that are imported from those modules (possibly indirect).

eraseConfigLocation :: Module a -> Module a Source #