Test.DocTest.Internal.Extract

Documentation

data Module a

Documentation for a module grouped together with the modules name.

Constructors

Module

Fields

• moduleName :: String
• moduleSetup :: Maybe a
• moduleContent :: [a]
• moduleConfig :: [Located String]

Instances

Functor Module

Defined in Test.DocTest.Internal.Extract

Methods

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

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

Eq a => Eq (Module a)

Defined in Test.DocTest.Internal.Extract

Methods

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

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

Show a => Show (Module a)

Defined in Test.DocTest.Internal.Extract

Methods

showsPrec :: Int -> Module a -> ShowS

show :: Module a -> String

showList :: [Module a] -> ShowS

Generic (Module a)

Defined in Test.DocTest.Internal.Extract

Associated Types

type Rep (Module a) :: Type -> Type

Methods

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

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

NFData a => NFData (Module a)

Defined in Test.DocTest.Internal.Extract

Methods

rnf :: Module a -> ()

type Rep (Module a)

Defined in Test.DocTest.Internal.Extract

type Rep (Module a) = D1 ('MetaData "Module" "Test.DocTest.Internal.Extract" "doctest-parallel-0.2.6-inplace" '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)]

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