-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Test.Framework wrapper for DocTest
--   
--   Test.Framework wrapper for DocTest
@package test-framework-doctest
@version 0.1


-- | Wrapper for running DocTests with Test.Framework
--   
--   First we get the doctests wrapped in <a>Test</a> using <a>docTest</a>.
--   The first argument to <a>docTest</a> should the root modules i.e., the
--   modules that are not imported by other modules.
--   
--   <pre>
--   &gt;&gt;&gt; doctests &lt;- docTest ["tests/Test.hs"] ["-itests"]
--   </pre>
--   
--   After getting the doctests we can execute the doctests using the
--   <a>defaultMain</a> or <a>defaultMainWithOpts</a> functions.
--   
--   <pre>
--   &gt;&gt;&gt; defaultMainWithOpts [doctests] $ defaultOptions { ropt_plain_output = Just True }
--   DocTest:
--     tests/Test.hs:
--       print "abc": [Failed]
--   Failed: expression `print "abc"'
--   expected: ["\"fail\""]
--    but got: ["\"abc\""]
--       print bar: [OK]
--   &lt;BLANKLINE&gt;
--            Test Cases  Total      
--    Passed  1           1          
--    Failed  1           1          
--    Total   2           2          
--   *** Exception: ExitFailure 1
--   </pre>
--   
--   Above we used <a>defaultMainWithOpts</a> for running the tests so that
--   we can specify that we want plain output instead of colored output.
--   Colored output looks like line noise in DocTests.
--   
--   The <tt>*** Exception: ExitFailure 1</tt> is caused by
--   <tt>defaultMainWithOptions</tt> trying to exit after finishing with
--   tests.
module Test.Framework.Providers.DocTest

-- | Note that <a>docTest</a> can be called only once per process execution
--   
--   You only need to give paths to modules that are not imported from any
--   other module
docTest :: [FilePath] -> [String] -> IO Test