aboutsummaryrefslogtreecommitdiff
path: root/src/Haddock/Backends
diff options
context:
space:
mode:
authorDavid Waern <unknown>2007-08-29 23:26:24 +0000
committerDavid Waern <unknown>2007-08-29 23:26:24 +0000
commit2ad606aaea58bce57ebb1681831514caf6ff56a3 (patch)
treea0f86d267a922efa5dc8929074934e5d605a86b5 /src/Haddock/Backends
parent658e79eddf0ac941d2719ec0a3aea58f42ef1277 (diff)
Rename HaddockModule to Interface and a few more refactorings
Diffstat (limited to 'src/Haddock/Backends')
-rw-r--r--src/Haddock/Backends/DevHelp.hs2
-rw-r--r--src/Haddock/Backends/Html.hs22
2 files changed, 12 insertions, 12 deletions
diff --git a/src/Haddock/Backends/DevHelp.hs b/src/Haddock/Backends/DevHelp.hs
index 9441d4a9..e92037f1 100644
--- a/src/Haddock/Backends/DevHelp.hs
+++ b/src/Haddock/Backends/DevHelp.hs
@@ -18,7 +18,7 @@ import Data.Maybe ( fromMaybe )
import qualified Data.Map as Map
import Text.PrettyPrint
-ppDevHelpFile :: FilePath -> String -> Maybe String -> [HaddockModule] -> IO ()
+ppDevHelpFile :: FilePath -> String -> Maybe String -> [Interface] -> IO ()
ppDevHelpFile odir doctitle maybe_package modules = do
let devHelpFile = package++".devhelp"
tree = mkModuleTree True [ (hmod_mod mod, toDescription mod) | mod <- modules ]
diff --git a/src/Haddock/Backends/Html.hs b/src/Haddock/Backends/Html.hs
index b49bf213..02a2e5c1 100644
--- a/src/Haddock/Backends/Html.hs
+++ b/src/Haddock/Backends/Html.hs
@@ -21,8 +21,8 @@ import Haddock.ModuleTree
import Haddock.Types
import Haddock.Version
import Haddock.Utils
-import Haddock.Utils.GHC
import Haddock.Utils.Html
+import Haddock.GHC.Utils
import qualified Haddock.Utils.Html as Html
import Control.Exception ( bracket )
@@ -55,7 +55,7 @@ type WikiURLs = (Maybe String, Maybe String, Maybe String)
ppHtml :: String
-> Maybe String -- package
- -> [HaddockModule]
+ -> [Interface]
-> FilePath -- destination directory
-> Maybe (GHC.HsDoc GHC.RdrName) -- prologue text, maybe
-> Maybe String -- the Html Help format (--html-help)
@@ -93,7 +93,7 @@ ppHtml doctitle maybe_package hmods odir prologue maybe_html_help_format
ppHtmlHelpFiles
:: String -- doctitle
-> Maybe String -- package
- -> [HaddockModule]
+ -> [Interface]
-> FilePath -- destination directory
-> Maybe String -- the Html Help format (--html-help)
-> [FilePath] -- external packages paths
@@ -150,7 +150,7 @@ footer =
toHtml ("version " ++ projectVersion)
)
-srcButton :: SourceURLs -> Maybe HaddockModule -> HtmlTable
+srcButton :: SourceURLs -> Maybe Interface -> HtmlTable
srcButton (Just src_base_url, _, _) Nothing =
topButBox (anchor ! [href src_base_url] << toHtml "Source code")
@@ -232,7 +232,7 @@ simpleHeader doctitle maybe_contents_url maybe_index_url
contentsButton maybe_contents_url <-> indexButton maybe_index_url
))
-pageHeader :: String -> HaddockModule -> String
+pageHeader :: String -> Interface -> String
-> SourceURLs -> WikiURLs
-> Maybe String -> Maybe String -> HtmlTable
pageHeader mdl hmod doctitle
@@ -257,7 +257,7 @@ pageHeader mdl hmod doctitle
)
)
-moduleInfo :: HaddockModule -> HtmlTable
+moduleInfo :: Interface -> HtmlTable
moduleInfo hmod =
let
info = hmod_info hmod
@@ -291,7 +291,7 @@ ppHtmlContents
-> Maybe String
-> SourceURLs
-> WikiURLs
- -> [HaddockModule] -> Bool -> Maybe (GHC.HsDoc GHC.RdrName)
+ -> [Interface] -> Bool -> Maybe (GHC.HsDoc GHC.RdrName)
-> IO ()
ppHtmlContents odir doctitle
maybe_package maybe_html_help_format maybe_index_url
@@ -392,7 +392,7 @@ mkNode ss (Node s leaf pkg short ts) depth id = htmlNode
(u,id') = mkNode (s:ss) x (depth+1) id
-- The URL for source and wiki links, and the current module
-type LinksInfo = (SourceURLs, WikiURLs, HaddockModule)
+type LinksInfo = (SourceURLs, WikiURLs, Interface)
-- ---------------------------------------------------------------------------
@@ -405,7 +405,7 @@ ppHtmlIndex :: FilePath
-> Maybe String
-> SourceURLs
-> WikiURLs
- -> [HaddockModule]
+ -> [Interface]
-> IO ()
ppHtmlIndex odir doctitle maybe_package maybe_html_help_format
maybe_contents_url maybe_source_url maybe_wiki_url modules = do
@@ -524,7 +524,7 @@ ppHtmlModule
:: FilePath -> String
-> SourceURLs -> WikiURLs
-> Maybe String -> Maybe String
- -> HaddockModule -> IO ()
+ -> Interface -> IO ()
ppHtmlModule odir doctitle
maybe_source_url maybe_wiki_url
maybe_contents_url maybe_index_url hmod = do
@@ -545,7 +545,7 @@ ppHtmlModule odir doctitle
)
writeFile (pathJoin [odir, moduleHtmlFile mod]) (renderHtml html)
-hmodToHtml :: SourceURLs -> WikiURLs -> HaddockModule -> HtmlTable
+hmodToHtml :: SourceURLs -> WikiURLs -> Interface -> HtmlTable
hmodToHtml maybe_source_url maybe_wiki_url hmod
= abovesSep s15 (contents: description: synopsis: maybe_doc_hdr: bdy)
where