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


-- | Write your tests in comments
--   
--   With some TemplateHaskell magic, you can write your tests in your
--   comments directly above a function declaration with a minimalistic
--   syntax.
@package testCom
@version 0.2.0


-- | <h2>Usage</h2>
--   
--   In any file, you can specify tests above a function declaration, like:
--   
--   <pre>
--   --[list of args] [exceptedResult]
--   --[1 2] [3]
--   add x y = x+y
--   
--   </pre>
--   
--   You can use any object deriving from Show and Eq as an argument for
--   tests. Later, on your test file, you can build tests functions with
--   
--   <pre>
--   {-# LANGUAGE TemplateHaskell #-}
--   $(makeAllTests "some/Path/File.hs")
--   
--   </pre>
--   
--   and use the produced function in your main:
--   
--   <pre>
--   import System.Exit
--   
--   main :: IO ()
--   main = do
--     let (str,res) = _TEST_some_Path_File
--     putStrLn str
--     if res then exitSuccess else exitFailure
--   
--   </pre>
--   
--   If you want to make tests on the actual file, you can use
--   
--   <pre>
--   $(makeAllTestsHere)
--   
--   </pre>
--   
--   the function produced will be equivalent to the one produced by
--   
--   <pre>
--   $(makeAllTests "path/to/file/known/by/ghc")
--   
--   </pre>
--   
--   <h2>String produced</h2>
--   
--   Considering the given file:
--   
--   <pre>
--   --[1 2] [3]
--   --[1 2] [4]
--   add x y = x+y
--   
--   </pre>
--   
--   The string produced will be:
--   
--   <pre>
--   Test passed: add 1 2  == 3
--   Error: add 1 2 /= 4 BUT == 3
--   
--   </pre>
module Test.TestCom

-- | With a path like some/Path/File.hs, Create a function
--   
--   <pre>
--   _TEST_some_Path_File :: (String,Bool)
--   </pre>
--   
--   with the string containing the result of all tests, and the boolean
--   set to <tt>True</tt> if and only if all tests passed
--   
--   This also create sub-functions that each produce a Eihter String
--   String
makeAllTests :: FilePath -> Q [Dec]
makeAllTestsHere :: Q [Dec]
instance GHC.Show.Show Test.TestCom.TestT