Modulehaskell-src-exts-1.23.1Haskell98

Language.Haskell.Exts.Comments

This module processes comments along with an annotated AST, to be able to associate Haddock comments with the actual item they refer to.

Example:

let
 parse1Result :: ParseResult (Module SrcSpanInfo,[Comment])
 parse1Result =
   parseFileContentsWithComments
    (defaultParseMode { parseFilename = file })
     contents
 withC :: ParseResult (Module (SrcSpanInfo,[Comment]))
 withC = case parse1Result of
           ParseOk res         -> ParseOk $ associateHaddock res
           ParseFailed sloc msg -> ParseFailed sloc msg

In this code sample, parse1Result is what you get when you parse a file: a Module annotated wth SrcSpanInfo, and a list of comments After passing the result to associateHaddock, you get a Module annotated with both a SrcSpanInfo and the list of Comment related to the specific AST node.

2 types
1 value

Packagehaskell-src-exts-1.23.1
Exports3
LanguageHaskell98
LicenceBSD-3-Clause
SourceComments.hs

valueassociateHaddock

:: (Annotated ast, Traversable ast)
=> (ast SrcSpanInfo, [Comment])
-> ast (SrcSpanInfo, [Comment])

Associates an AST with Source Span Information with relevant Haddock comments

datadata Comment

A Haskell comment. The Bool is True if the comment is multi-line, i.e. {- -}.

Constructors

Comment Bool SrcSpan String

Instances3Eq, Data, Show

Eq CommentDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Comments
Data CommentDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Comments
Show CommentDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Comments

datadata UnknownPragma

An unknown pragma.

Constructors

UnknownPragma SrcSpan String

Instances3Eq, Data, Show

Eq UnknownPragmaDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Comments
Data UnknownPragmaDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Comments
Show UnknownPragmaDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Comments