Ticket #44 (proposed-project)
Opened 2 months ago
Last modified 1 month ago
Port Haddock to use the GHC API
Status: new
| Reported by: | simonmar@microsoft.com | Assigned to: | none |
|---|---|---|---|
| Milestone: | kick off coding | Component: | misc |
| Keywords: | haddock ghc | Cc: | |
| Topic: | Haddock | Difficulty: | 1 person Summer |
| Mentor: | not-accepted |
Haddock currently uses its own Haskell parser. It lacks supports for some GHC extensions, and it requires its own implementation of the Haskell module system, has its own format for interface files, and so on. It can't produce documentation for functions that have no type signatures, because it has no type system and can't infer the types.
If Haddock were built on top of the new GHC API, these shortcomings would be fixed, and Haddock would get a lot shorter (although the binary might be larger :-). GHC's parser would need to be adapted to handle Haddock-style documentation annotations, and the abstract syntax would have to carry these around.
Interested Mentors
- Simon Marlow <simonmar@microsoft.com>
Interested Students
- David Waern <davve@dtek.chalmers.se>
Change History
04/26/06 08:05:28: Modified by paolo
- description changed.
04/26/06 12:06:06: Modified by waern
- description changed.
04/26/06 14:26:17: Modified by paolo
- topic changed from misc to Haddock.
- description changed.
05/04/06 05:06:12: Modified by simonmar
- description changed.
05/25/06 03:25:12: Modified by waern
- milestone set to kick off coding.
