Changes between Version 17 and Version 18 of HaddockComments


Ignore:
Timestamp:
Oct 21, 2006 10:25:35 PM (9 years ago)
Author:
waern
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • HaddockComments

    v17 v18  
    4747The doc comments go through the renamer, and the reason is that an {{{HsDoc}}} can contain a reference to an identifier. It can be important for users of the GHC API to get hold of comments that contain the original name of references ({{{HsDoc Name}}}).
    4848
     49= The GHC API =
     50The doc comments are present in the {{{ParsedSource}}} as well as in the {{{RenamedSource}}}.
     51
     52There are three pieces of information besides the ordinary comments themselves that could also be of interest. Those are the doc options, the module-specific doc comment and the Haddock module header information. All of them are available in the {{{HsModule}}} data type in the {{{ParsedSource}}}. The last two pieces of information may contain names of identifiers, so they are also part of the renamed syntax. They can be obtained from the last two elements in the {{{RenamedSource}}} 5-tuple, as seen below.
     53{{{
     54type RenamedSource     = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
     55                          Maybe (HsDoc Name), HaddockModInfo Name)
     56}}}
     57
    4958= Misc =
    5059.hi-files are left untouched by this extension.