Fixme.Comment

Understand comments

type Comment = Located Text

data Located a

A thing that is located somewhere in a text file.

Instances

Eq a => Eq (Located a)

Methods

(==) :: Located a -> Located a -> Bool

(/=) :: Located a -> Located a -> Bool

Show a => Show (Located a)

Methods

showsPrec :: Int -> Located a -> ShowS

show :: Located a -> String

showList :: [Located a] -> ShowS

parseComments :: Language -> Text -> [Comment]

Given some source code, return a list of comments.

commentText :: Comment -> Text

startLine :: Located a -> Int

endLine :: Comment -> Int

Exposed for testing

newComment :: Int -> Text -> Comment

parseComments' :: [SourceLine] -> [Comment]

Given a consecutive sequence of lexed lines of source, return a list of all the comments found, along with the line number on which the comment starts.

Understand programming languages

type Language = Text

Wrappers around syntax highlighting code.

languageForFile :: Text -> Maybe Language

Exposed for testing

highlightCode :: Language -> Text -> [SourceLine]