Language.Haskell.Homplexity.Comments

Documentation

data CommentLink

Describes the comment span, and the way it may be connected to the source code

Constructors

CommentLink

Fields

• commentSpan :: SrcSpan
• commentType :: CommentType

Instances

Eq CommentLink

Defined in Language.Haskell.Homplexity.Comments

Methods

(==) :: CommentLink -> CommentLink -> Bool

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

Ord CommentLink

Defined in Language.Haskell.Homplexity.Comments

Methods

compare :: CommentLink -> CommentLink -> Ordering

(<) :: CommentLink -> CommentLink -> Bool

(<=) :: CommentLink -> CommentLink -> Bool

(>) :: CommentLink -> CommentLink -> Bool

(>=) :: CommentLink -> CommentLink -> Bool

max :: CommentLink -> CommentLink -> CommentLink

min :: CommentLink -> CommentLink -> CommentLink

Show CommentLink

Defined in Language.Haskell.Homplexity.Comments

Methods

showsPrec :: Int -> CommentLink -> ShowS

show :: CommentLink -> String

showList :: [CommentLink] -> ShowS

data CommentType

Possible link between comment and commented entity.

Constructors

CommentsBefore

May be counted as commenting object that starts just before.

CommentsInside

May be counted as commenting object within which it exists.

CommentsAfter

May be counted as commenting object that starts just after.

Instances

Enum CommentType

Defined in Language.Haskell.Homplexity.Comments

Methods

succ :: CommentType -> CommentType

pred :: CommentType -> CommentType

toEnum :: Int -> CommentType

fromEnum :: CommentType -> Int

enumFrom :: CommentType -> [CommentType]

enumFromThen :: CommentType -> CommentType -> [CommentType]

enumFromTo :: CommentType -> CommentType -> [CommentType]

enumFromThenTo :: CommentType -> CommentType -> CommentType -> [CommentType]

Eq CommentType

Defined in Language.Haskell.Homplexity.Comments

Methods

(==) :: CommentType -> CommentType -> Bool

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

Ord CommentType

Defined in Language.Haskell.Homplexity.Comments

Methods

compare :: CommentType -> CommentType -> Ordering

(<) :: CommentType -> CommentType -> Bool

(<=) :: CommentType -> CommentType -> Bool

(>) :: CommentType -> CommentType -> Bool

(>=) :: CommentType -> CommentType -> Bool

max :: CommentType -> CommentType -> CommentType

min :: CommentType -> CommentType -> CommentType

Show CommentType

Defined in Language.Haskell.Homplexity.Comments

Methods

showsPrec :: Int -> CommentType -> ShowS

show :: CommentType -> String

showList :: [CommentType] -> ShowS

classifyComments :: [Comment] -> [CommentLink]

Classifies all comments in list, so they can be assigned to declarations later.

findCommentType :: String -> CommentType

Finds Haddock markers of which declarations the comment pertains to.

data CommentSite

Tagging of source range for each commentable object.

Constructors

CommentSite

Fields

• siteName :: String
• siteSlice :: SrcSlice

Instances

Eq CommentSite

Defined in Language.Haskell.Homplexity.Comments

Methods

(==) :: CommentSite -> CommentSite -> Bool

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

Show CommentSite

Defined in Language.Haskell.Homplexity.Comments

Methods

showsPrec :: Int -> CommentSite -> ShowS

show :: CommentSite -> String

showList :: [CommentSite] -> ShowS

commentable :: Data from => from -> [CommentSite]

Find comment sites for entire program.

orderCommentsAndCommentables :: [CommentSite] -> [CommentLink] -> [Either CommentLink CommentSite]

Take together are commentable elements, and all comments, and order them by source location.