Language.Haskell.Exts.SimpleComments

Data types

data CodeComment

Annotate AST with comments.

Constructors

CodeComment

Fields

• ccPos :: !CommentPos

  How to place comment

• ccSym :: !Char

  Special character to prepend to the first line keeping the alignment; e.g. * for haddock sections, '|' for top-level haddock declarations. If ' '(space) is used, no additional indentation is added.

• ccTxt :: !String

  Content of a comment (can be multiline)

Instances

Eq CodeComment

Methods

(==) :: CodeComment -> CodeComment -> Bool

(/=) :: CodeComment -> CodeComment -> Bool

Read CodeComment

Methods

readsPrec :: Int -> ReadS CodeComment

readList :: ReadS [CodeComment]

readPrec :: ReadPrec CodeComment

readListPrec :: ReadPrec [CodeComment]

Show CodeComment

Methods

showsPrec :: Int -> CodeComment -> ShowS

show :: CodeComment -> String

showList :: [CodeComment] -> ShowS

IsString CodeComment

Methods

fromString :: String -> CodeComment

data CommentPos

Where to place a comment, relative to an AST node

Constructors

AboveCode

BelowCode

NextToCode

Instances

Eq CommentPos

Methods

(==) :: CommentPos -> CommentPos -> Bool

(/=) :: CommentPos -> CommentPos -> Bool

Read CommentPos

Methods

readsPrec :: Int -> ReadS CommentPos

readList :: ReadS [CommentPos]

readPrec :: ReadPrec CommentPos

readListPrec :: ReadPrec [CommentPos]

Show CommentPos

Methods

showsPrec :: Int -> CommentPos -> ShowS

show :: CommentPos -> String

showList :: [CommentPos] -> ShowS

Generate source code

ppWithCommentsStyleModeParseMode :: Style -> PPHsMode -> ParseMode -> Module (Maybe CodeComment) -> (Module SrcSpanInfo, [Comment])

Run pretty print and parse to obtain SrcSpanInfo, then gradually insert comments.

ppWithCommentsStyleMode :: Style -> PPHsMode -> Module (Maybe CodeComment) -> (Module SrcSpanInfo, [Comment])

ppWithCommentsStyleModeParseMode with default parse style

ppWithCommentsMode :: PPHsMode -> Module (Maybe CodeComment) -> (Module SrcSpanInfo, [Comment])

ppWithCommentsStyleMode with default style

ppWithComments :: Module (Maybe CodeComment) -> (Module SrcSpanInfo, [Comment])

ppWithCommentsMode with default mode

Convenience functions

preComment :: String -> Maybe CodeComment

Add haddock-style comment above some definition

postComment :: String -> Maybe CodeComment

Add haddock-style comment below some definition

secComment :: String -> Maybe CodeComment

Add haddock-style section (*), use it on definitions in an export list.