Cleanup, document and improve the GHC API

[simonmar]

The GHC API currently has no documentation beyond the source and a few wiki pages, e.g.  http://haskell.org/haskellwiki/GHC/As_a_library. The GHC API has grown on demand: it contains mostly what GHCi needs, and not much else. This project would involve:

• Document the GHC API using Haddock (Haddock 2 should be able to process GHC now).

• Survey current and potential users of the GHC API to identify what they need

• Cleanup and extend the API as necessary. Parts of its implementation are in dire need of some internal refactoring too.

The goal would be to present an easy to use and well-documented GHC API for GHC 6.10, and a selection of example code for potential users to start from.

See also  http://hackage.haskell.org/trac/ghc/ticket/1467.

Interested Mentors

• Simon Marlow

Interested Students

• Thomas Schilling (nominolo)
• Giuliano Losa (nano), <giuliano.losa@…>

[simonmar]

Done by Thomas Schilling last year.