doctest-0.22.2: Test interactive Haskell examples
Safe HaskellSafe-Inferred
LanguageHaskell2010

Test.DocTest.Internal.Extract

Synopsis

Documentation

data Module a Source #

Documentation for a module grouped together with the modules name.

Constructors

Module 

Instances

Instances details
Functor Module Source # 
Instance details

Defined in Extract

Methods

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

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

Show a => Show (Module a) Source # 
Instance details

Defined in 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 Extract

Methods

rnf :: Module a -> () #

Eq a => Eq (Module a) Source # 
Instance details

Defined in Extract

Methods

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

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

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).