Module AbstractCurryComments

Operations to read the documentation comments in a Curry program.

Author: Michael Hanus

Summary of exported operations:

readCurryWithComments
                  :: String -> IO CurryProg

I/O action which parses a Curry program and returns the corresponding typed Abstract Curry program.

readComments
                  :: String -> IO (String,String -> String,String -> String)

Reads all documentation comments of a source file.

Exported operations:

readCurryWithComments :: String -> IO CurryProg

I/O action which parses a Curry program and returns the corresponding typed Abstract Curry program. In addition to the operation AbstractCurry.readCurry, this I/O action also reads the documentation comments in the source file and puts the function comments into the function declarations of the Abstract Curry program (i.e., it uses the constructor CmtFunc instead of CFunc whenever possible).

readComments :: String -> IO (String,String -> String,String -> String)

Reads all documentation comments of a source file. This operation returns the module comment, a mapping from type names into their documentation comments, and a mapping from function names into their documentation comments.