Skip to content
  • duncan.coutts@worc.ox.ac.uk's avatar
    43bb89fa
    Teach haddock about line pragmas and add accurate source code links · 43bb89fa
    duncan.coutts@worc.ox.ac.uk authored
    Teach haddock about C and Haskell style line pragmas. Extend the lexer/parser's
    source location tracking to include the file name as well as line/column. This
    way each AST item that is tagged with a SrcLoc gets the original file name too.
    
    Use this original file name to add source links to each exported item, in the
    same visual style as the wiki links. Note that the per-export source links are
    to the defining module rather than whichever module haddock pretends it is
    exported from. This is what we want for source code links. The source code link
    URL can also contain the name of the export so one could implement jumping to
    the actual location of the function in the file if it were linked to an html
    version of the source rather than just plain text. The name can be selected
    with the %N wild card.
    
    So for linking to the raw source code one might use:
    --source=http://darcs/haskell.org/foo/%F
    
    Or for linking to html syntax highlighted code:
    --source=http://darcs/haskell.org/foo/%M.html#%N
    43bb89fa
    Teach haddock about line pragmas and add accurate source code links
    duncan.coutts@worc.ox.ac.uk authored
    Teach haddock about C and Haskell style line pragmas. Extend the lexer/parser's
    source location tracking to include the file name as well as line/column. This
    way each AST item that is tagged with a SrcLoc gets the original file name too.
    
    Use this original file name to add source links to each exported item, in the
    same visual style as the wiki links. Note that the per-export source links are
    to the defining module rather than whichever module haddock pretends it is
    exported from. This is what we want for source code links. The source code link
    URL can also contain the name of the export so one could implement jumping to
    the actual location of the function in the file if it were linked to an html
    version of the source rather than just plain text. The name can be selected
    with the %N wild card.
    
    So for linking to the raw source code one might use:
    --source=http://darcs/haskell.org/foo/%F
    
    Or for linking to html syntax highlighted code:
    --source=http://darcs/haskell.org/foo/%M.html#%N
Loading