Reduced the number of Haddock warnings

kowey · Jan 3, 2016 · cb35332 · cb35332
1 parent eacbf2f
commit cb35332
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 2 deletions.
diff --git a/wxcore/src/haskell/Graphics/UI/WXCore/Types.hs b/wxcore/src/haskell/Graphics/UI/WXCore/Types.hs
@@ -1,4 +1,5 @@
 {-# LANGUAGE ForeignFunctionInterface #-}
+{-# OPTIONS_HADDOCK prune #-}
 -----------------------------------------------------------------------------------------
 {-|
 Module      :  Types

diff --git a/wxcore/src/haskell/Graphics/UI/WXCore/WxcDefs.hs b/wxcore/src/haskell/Graphics/UI/WXCore/WxcDefs.hs
@@ -1,3 +1,6 @@
+
+{-# OPTIONS_HADDOCK prune #-}
+
 --------------------------------------------------------------------------------
 {-| 
 Module      :  WxcDefs

diff --git a/wxcore/src/haskell/Graphics/UI/WXCore/WxcTypes.hs b/wxcore/src/haskell/Graphics/UI/WXCore/WxcTypes.hs
@@ -1,5 +1,6 @@
 {-# LANGUAGE CPP, ForeignFunctionInterface, DeriveDataTypeable, FlexibleInstances #-}
 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
+{-# OPTIONS_HADDOCK prune #-}
 -----------------------------------------------------------------------------------------
 {-|
 Module      :  WxcTypes

diff --git a/wxdirect/src/CompileClassInfo.hs b/wxdirect/src/CompileClassInfo.hs
@@ -105,9 +105,10 @@ compileClassInfo _verbose moduleRoot moduleClassesName moduleClassTypesName modu
                               ]
            prologue = getPrologue moduleName "class info"
                                         (show defCount ++ " class info definitions.") []
+           haddockPrune = ["{-# OPTIONS_HADDOCK prune #-}"]
 
        putStrLn ("generating: " ++ outputFile)
-       writeFileLazy outputFile (unlines (prologue ++ export ++ classDefs ++ downcDefs))
+       writeFileLazy outputFile (unlines (haddockPrune ++ prologue ++ export ++ classDefs ++ downcDefs))
        putStrLn ("generated " ++ show defCount ++ " class info definitions")
        putStrLn "ok."
 

diff --git a/wxdirect/src/CompileClasses.hs b/wxdirect/src/CompileClasses.hs
@@ -125,7 +125,8 @@ compileClassesFile _showIgnore moduleRoot moduleClassTypesName moduleName output
            prologue = getPrologue moduleName "class"
                                    (show methodCount ++ " methods for " ++ show classCount ++ " classes.")
                                    inputFiles
-           output  = unlines (ghcoptions ++ prologue ++ export ++ marshalDecls)
+           haddockPrune = ["{-# OPTIONS_HADDOCK prune #-}"]
+           output  = unlines (haddockPrune ++ ghcoptions ++ prologue ++ export ++ marshalDecls)
 
        putStrLn ("generating: " ++ outputFile ++ ".hs")
        writeFileLazy (outputFile ++ ".hs") output