id	summary	reporter	owner	description	type	status	priority	resolution	keywords	cc	topic	difficulty	mentor
1568	Haddock: refactor to move doc parsing code from GHC into Haddock	simonmar		"The code for parsing and renaming Haddock comments is currently in GHC. This is clearly not good, since any changes to the comment format have to be made in GHC.  It was done this way because GHC implements the module system and can therefore resolve links to names from documentation.  

However, the GHC API now provides a way to get hold of the top-level environment. This allows us to move parsing and renaming of Haddock comments back into Haddock.

This would be an improvement for modularity, and would make the Haddock markup format easier to modify in the future.

Please note that we so far only speak about parsing and renaming the Haddock comments themselves, and not about parsing Haskell code containing comments. The parsing of Haskell code containing comments is done the GHC parser, but could perhaps also be done separately in Haddock. We have not yet decided if this is a good idea or not, but it could be discussed and experimented with.

This project probably won't take the whole 3 months on its own, so it could be combined with one or more of the other Haddock projects (eg. #1567, #1569).

== Interested Mentors ==

 * David Waern
 * Simon Marlow
 * Duncan Coutts (co-mentor)

== Interested Students ==

 * Maciej Kotowicz ( kotowicz<dot>maciej<at>gmail<dot>com )
 * Isaac Dupree <id@isaac.cedarswampstudios.org>
"	proposed-project	closed	good	fixed		id@…	Haddock	unknown	not-accepted
