Difference between revisions of "Haddock/Development ideas"

From HaskellWiki
Jump to navigation Jump to search
m (Haddock:development ideas moved to Haddock/Development ideas)
m
Line 1: Line 1:
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:as_a_library|GHC API]]:
+
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/as_a_library|GHC API]]:
   
 
* Haddock would get full supprot for GHC's various syntactic extensions.
 
* Haddock would get full supprot for GHC's various syntactic extensions.

Revision as of 07:04, 6 February 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