Opened 11 years ago

Closed 10 years ago

Last modified 9 years ago

#44 closed proposed-project (fixed)

Port Haddock to use the GHC API

Reported by: simonmar@… Owned by: none
Priority: Keywords: haddock ghc
Cc: Difficulty: 1 person Summer
Mentor: not-accepted Topic: Haddock

Description (last modified by simonmar)

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@…>

Interested Students

  • David Waern <davve@…>

Change History (7)

comment:1 Changed 11 years ago by paolo

Description: modified (diff)

comment:2 Changed 11 years ago by waern

Description: modified (diff)

comment:3 Changed 11 years ago by paolo

Description: modified (diff)
Topic: miscHaddock

comment:4 Changed 11 years ago by simonmar

Description: modified (diff)

comment:5 Changed 11 years ago by waern

milestone: kick off coding

comment:6 Changed 10 years ago by simonmar

Resolution: fixed
Status: newclosed

Done by David Wearn last year; project still ongoing.

comment:7 Changed 9 years ago by (none)

Milestone kick off coding deleted

Note: See TracTickets for help on using tickets.