diff options
| author | Niklas Haas <git@nand.wakku.to> | 2014-03-09 06:07:09 +0100 |
|---|---|---|
| committer | Niklas Haas <git@nand.wakku.to> | 2014-03-09 07:53:46 +0100 |
| commit | 003f11795e4413abae5275e8a855765c571ccab9 (patch) | |
| tree | ffb3d98d8883a236347e069545adf2f2d3bf3405 /src/Haddock/Options.hs | |
| parent | 9aa5a2a420788e39806c5fe85845002181f3b945 (diff) | |
Differentiate between TH splices (line-links) and regular names
This adds a new type of source code link, to a specific line rather than
a specific declaration/name - this is used to link to the location of a
TH splice that defines a certain name.
Rather hefty changes throughout and still one unresolved issue (the line
URLs aren't parsed from the third form of --read-interface which means
they're currently restricted to same-interface links). Not sure if
this issue is really worth all the hassle, especially since we could
just use line links in general.
This commit also contains some cleanup/clarification of the types in
Haddock.Backends.Xhtml.Decl and shortens some overlong lines in the
process. Notably, the Bool parameter was replaced by a Unicode type
synonym to help clarify its presence in type signatures.
Diffstat (limited to 'src/Haddock/Options.hs')
| -rw-r--r-- | src/Haddock/Options.hs | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/src/Haddock/Options.hs b/src/Haddock/Options.hs index 2e10827e..b166de46 100644 --- a/src/Haddock/Options.hs +++ b/src/Haddock/Options.hs @@ -51,9 +51,10 @@ data Flag | Flag_Lib String | Flag_OutputDir FilePath | Flag_Prologue FilePath - | Flag_SourceBaseURL String - | Flag_SourceModuleURL String - | Flag_SourceEntityURL String + | Flag_SourceBaseURL String + | Flag_SourceModuleURL String + | Flag_SourceEntityURL String + | Flag_SourceLEntityURL String | Flag_WikiBaseURL String | Flag_WikiModuleURL String | Flag_WikiEntityURL String @@ -114,6 +115,8 @@ options backwardsCompat = "URL for a source code link for each module\n(using the %{FILE} or %{MODULE} vars)", Option [] ["source-entity"] (ReqArg Flag_SourceEntityURL "URL") "URL for a source code link for each entity\n(using the %{FILE}, %{MODULE}, %{NAME},\n%{KIND} or %{LINE} vars)", + Option [] ["source-entity-line"] (ReqArg Flag_SourceLEntityURL "URL") + "URL for a source code link for each entity.\nUsed if name links are unavailable, eg. for TH splices.", Option [] ["comments-base"] (ReqArg Flag_WikiBaseURL "URL") "URL for a comments link on the contents\nand index pages", Option [] ["comments-module"] (ReqArg Flag_WikiModuleURL "URL") @@ -216,11 +219,12 @@ optCssFile :: [Flag] -> Maybe FilePath optCssFile flags = optLast [ str | Flag_CSS str <- flags ] -sourceUrls :: [Flag] -> (Maybe String, Maybe String, Maybe String) +sourceUrls :: [Flag] -> (Maybe String, Maybe String, Maybe String, Maybe String) sourceUrls flags = - (optLast [str | Flag_SourceBaseURL str <- flags] - ,optLast [str | Flag_SourceModuleURL str <- flags] - ,optLast [str | Flag_SourceEntityURL str <- flags]) + (optLast [str | Flag_SourceBaseURL str <- flags] + ,optLast [str | Flag_SourceModuleURL str <- flags] + ,optLast [str | Flag_SourceEntityURL str <- flags] + ,optLast [str | Flag_SourceLEntityURL str <- flags]) wikiUrls :: [Flag] -> (Maybe String, Maybe String, Maybe String) |