Changes between Version 3 and Version 4 of Ticket #1568


Ignore:
Timestamp:
Mar 19, 2009 11:24:40 PM (5 years ago)
Author:
waern
Comment:

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #1568 – Description

    v3 v4  
    1 All the code for parsing and renmaing documentation is currently in GHC.  This is clearly not good, since any changes to documentation 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.   
     1The 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.   
    22 
    3 However, the GHC API now provides a way to get hold of the top-level environment, and the lexer now provides a way to get access to the comments from a module.  These two features allow us to refactor Haddock and move much of the Haddock-specific code currently in GHC back into Haddock. 
     3However, 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. 
    44 
    5 This would be a huge improvement for modularity, and would make Haddock a lot easier to modify in the future. 
     5This would be an improvement for modularity, and would make the Haddock markup format easier to modify in the future. 
     6 
     7Please 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. 
    68 
    79This 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).