Personal tools

Haddock/Development ideas

From HaskellWiki

< Haddock(Difference between revisions)
Jump to: navigation, search
m (fix)
(Recursive directories)
Line 7: Line 7:
 
* GHCi and IDEs like [[hIDE]] and [[Visual Haskell]] would be able to display API documentation in more convenient ways like in this [http://haste.dyndns.org:8080/ Haste] screenshot:
 
* GHCi and IDEs like [[hIDE]] and [[Visual Haskell]] would be able to display API documentation in more convenient ways like in this [http://haste.dyndns.org:8080/ Haste] screenshot:
 
[[Image:Haste_screenshot_hovering.png]]
 
[[Image:Haste_screenshot_hovering.png]]
  +
  +
It would be good to have a recursive flag that would operate on all the .hs and .lhs files under a single directory.

Revision as of 11:57, 1 November 2006

There would be a number of benefits if GHC's parser were extended to understand the Haddock documentation markup and then Haddock changed to use the GHC API:

  • Haddock would get full supprot for GHC's various syntactic extensions.
  • Haddock would understand {#- LINE -#} pragmas which would allow it to generate links to the original source code.
  • Haddock would get much better error messages.
  • Haddock could infer types for functions with no explicit type signature.
  • GHCi and IDEs like hIDE and Visual Haskell would be able to display API documentation in more convenient ways like in this Haste screenshot:

Haste screenshot hovering.png

It would be good to have a recursive flag that would operate on all the .hs and .lhs files under a single directory.