Safe Haskell	Safe-Inferred
Language	Haskell2010

Language.Haskell.Homplexity.Comments

Synopsis

Documentation

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

Constructors

CommentLink
Fields commentSpan :: SrcSpan commentType :: CommentType

Instances details

Show CommentLink Source #
Instance details Defined in Language.Haskell.Homplexity.Comments Methods showsPrec :: Int -> CommentLink -> ShowS show :: CommentLink -> String showList :: [CommentLink] -> ShowS
Eq CommentLink Source #
Instance details Defined in Language.Haskell.Homplexity.Comments Methods (==) :: CommentLink -> CommentLink -> Bool (/=) :: CommentLink -> CommentLink -> Bool
Ord CommentLink Source #
Instance details 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

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 details

Enum CommentType Source #
Instance details 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]
Show CommentType Source #
Instance details Defined in Language.Haskell.Homplexity.Comments Methods showsPrec :: Int -> CommentType -> ShowS show :: CommentType -> String showList :: [CommentType] -> ShowS
Eq CommentType Source #
Instance details Defined in Language.Haskell.Homplexity.Comments Methods (==) :: CommentType -> CommentType -> Bool (/=) :: CommentType -> CommentType -> Bool
Ord CommentType Source #
Instance details 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

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

Finds Haddock markers of which declarations the comment pertains to.

Tagging of source range for each commentable object.

Constructors

CommentSite
Fields siteName :: String siteSlice :: SrcSlice

Instances details

Show CommentSite Source #
Instance details Defined in Language.Haskell.Homplexity.Comments Methods showsPrec :: Int -> CommentSite -> ShowS show :: CommentSite -> String showList :: [CommentSite] -> ShowS
Eq CommentSite Source #
Instance details Defined in Language.Haskell.Homplexity.Comments Methods (==) :: CommentSite -> CommentSite -> Bool (/=) :: CommentSite -> CommentSite -> Bool

Find comment sites for entire program.

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