| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Language.Haskell.Homplexity.Comments
- data CommentLink = CommentLink {
- commentSpan :: SrcSpan
- commentType :: CommentType
- data CommentType
- classifyComments :: [Comment] -> [CommentLink]
- findCommentType :: String -> CommentType
- data CommentSite = CommentSite {}
- commentable :: Data from => from -> [CommentSite]
- orderCommentsAndCommentables :: [CommentSite] -> [CommentLink] -> [Either CommentLink CommentSite]
Documentation
data CommentLink Source
Describes the comment span, and the way it may be connected to the source code
Constructors
| CommentLink | |
Fields
| |
Instances
data CommentType Source
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. |
classifyComments :: [Comment] -> [CommentLink] Source
Classifies all comments in list, so they can be assigned to declarations later.
findCommentType :: String -> CommentType Source
Finds Haddock markers of which declarations the comment pertains to.
data CommentSite Source
Tagging of source range for each commentable object.
Constructors
| CommentSite | |
Instances
commentable :: Data from => from -> [CommentSite] Source
Find comment sites for entire program.
orderCommentsAndCommentables :: [CommentSite] -> [CommentLink] -> [Either CommentLink CommentSite] Source
Take together are commentable elements, and all comments, and order them by source location.