X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=compiler%2FhsSyn%2FHsDoc.hs;h=bd75408f11a9e33cd45ebdcf2365b72248f51392;hb=83e979b3db9acba32973ce065fce6248ee0f59a6;hp=51ef579a7588233650eeddae10820ae686bdcd04;hpb=190f24892156953d73b55401d0467a6f1a88ce5d;p=ghc-hetmet.git diff --git a/compiler/hsSyn/HsDoc.hs b/compiler/hsSyn/HsDoc.hs index 51ef579..bd75408 100644 --- a/compiler/hsSyn/HsDoc.hs +++ b/compiler/hsSyn/HsDoc.hs @@ -1,3 +1,10 @@ +{-# OPTIONS -w #-} +-- The above warning supression flag is a temporary kludge. +-- While working on this module you are encouraged to remove it and fix +-- any warnings in the module. See +-- http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings +-- for details + module HsDoc ( HsDoc(..), LHsDoc, @@ -8,7 +15,6 @@ module HsDoc ( #include "HsVersions.h" -import RdrName import Outputable import SrcLoc @@ -28,6 +34,7 @@ data HsDoc id | DocDefList [(HsDoc id, HsDoc id)] | DocCodeBlock (HsDoc id) | DocURL String + | DocPic String | DocAName String deriving (Eq, Show) @@ -62,16 +69,34 @@ docAppend d1 d2 -- is a DocMonospaced and make it into a DocCodeBlock docParagraph :: HsDoc id -> HsDoc id docParagraph (DocMonospaced p) - = DocCodeBlock p + = DocCodeBlock (docCodeBlock p) docParagraph (DocAppend (DocString s1) (DocMonospaced p)) | all isSpace s1 - = DocCodeBlock p + = DocCodeBlock (docCodeBlock p) docParagraph (DocAppend (DocString s1) (DocAppend (DocMonospaced p) (DocString s2))) | all isSpace s1 && all isSpace s2 - = DocCodeBlock p + = DocCodeBlock (docCodeBlock p) docParagraph (DocAppend (DocMonospaced p) (DocString s2)) | all isSpace s2 - = DocCodeBlock p + = DocCodeBlock (docCodeBlock p) docParagraph p = DocParagraph p + + +-- Drop trailing whitespace from @..@ code blocks. Otherwise this: +-- +-- -- @ +-- -- foo +-- -- @ +-- +-- turns into (DocCodeBlock "\nfoo\n ") which when rendered in HTML +-- gives an extra vertical space after the code block. The single space +-- on the final line seems to trigger the extra vertical space. +-- +docCodeBlock :: HsDoc id -> HsDoc id +docCodeBlock (DocString s) + = DocString (reverse $ dropWhile (`elem` " \t") $ reverse s) +docCodeBlock (DocAppend l r) + = DocAppend l (docCodeBlock r) +docCodeBlock d = d