Camfort.Analysis.CommentAnnotator

Documentation

annotateComments :: forall a ast. (Data a, Linkable a, ASTEmbeddable a ast) => AnnotationParser ast -> ProgramFile a -> Logger (ProgramFile a)

type Logger = Writer [String]

class ASTEmbeddable a ast where

Minimal complete definition

annotateWithAST

Methods

annotateWithAST :: a -> ast -> a

Instances

ASTEmbeddable UA UnitStatement

Methods

annotateWithAST :: UA -> UnitStatement -> UA

class Linkable a where

Minimal complete definition

link, linkPU

Methods

link :: a -> Block a -> a

linkPU :: a -> ProgramUnit a -> a

linkMultiple :: [Block a] -> [Block a] -> ([Block a], [Block a])

linkMultiplePUs :: [ProgramUnit a] -> [ProgramUnit a] -> ([ProgramUnit a], [ProgramUnit a])

Instances

Linkable UA

Methods

link :: UA -> Block UA -> UA

linkPU :: UA -> ProgramUnit UA -> UA

linkMultiple :: [Block UA] -> [Block UA] -> ([Block UA], [Block UA])

linkMultiplePUs :: [ProgramUnit UA] -> [ProgramUnit UA] -> ([ProgramUnit UA], [ProgramUnit UA])

data AnnotationParseError

Constructors

NotAnnotation

ProbablyAnnotation String

Instances

Eq AnnotationParseError

Methods

(==) :: AnnotationParseError -> AnnotationParseError -> Bool

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

Show AnnotationParseError

Methods

showsPrec :: Int -> AnnotationParseError -> ShowS

show :: AnnotationParseError -> String

showList :: [AnnotationParseError] -> ShowS

type AnnotationParser ast = String -> Either AnnotationParseError ast

failWith :: AnnotationParser ast