[GHC] #8201: Haddockifying the documentation in HsSyn
#8201: Haddockifying the documentation in HsSyn ------------------------------------+------------------------------------- Reporter: DaniilFrumin | Owner: Type: bug | Status: new Priority: low | Milestone: Component: Documentation | Version: 7.7 Keywords: | Operating System: Unknown/Multiple Architecture: Unknown/Multiple | Type of failure: None/Unknown Difficulty: Unknown | Test Case: Blocked By: | Blocking: Related Tickets: | ------------------------------------+------------------------------------- I took the liberty of making some cosmetic changes to the comments in HsBinds.lhs and HsExpr.lhs. Particularly I've made most of the relevants comments appear as Haddock annotations for datatypes and constructors. This way a user of GHC API (or a GHC dev) can refer to the haddocks in order to find out what does the given datatype/constructor represent/do instead of digging too deep in the source code. You can see the output here: <http://co-dan.github.io/ghc- docs/HsExpr.html>, http://co-dan.github.io/ghc-docs/HsBinds.html This patch on github: https://github.com/co-dan/ghc/compare/hssyn-docs Related wiki pages: Commentary/Compiler/HsSynType If this proves useful I may update documentation in other files. -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8201 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8201: Haddockifying the documentation in HsSyn -------------------------------------+------------------------------------ Reporter: DaniilFrumin | Owner: Type: bug | Status: patch Priority: low | Milestone: Component: Documentation | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by DaniilFrumin): * status: new => patch -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8201#comment:1 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8201: Haddockifying the documentation in HsSyn -------------------------------------+------------------------------------ Reporter: DaniilFrumin | Owner: jstolarek Type: bug | Status: patch Priority: low | Milestone: Component: Documentation | Version: 7.7 Resolution: | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by jstolarek): * owner: => jstolarek -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8201#comment:2 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
#8201: Haddockifying the documentation in HsSyn
-------------------------------------+------------------------------------
Reporter: DaniilFrumin | Owner: jstolarek
Type: bug | Status: patch
Priority: low | Milestone:
Component: Documentation | Version: 7.7
Resolution: | Keywords:
Operating System: Unknown/Multiple | Architecture: Unknown/Multiple
Type of failure: None/Unknown | Difficulty: Unknown
Test Case: | Blocked By:
Blocking: | Related Tickets:
-------------------------------------+------------------------------------
Comment (by Jan Stolarek
#8201: Haddockifying the documentation in HsSyn -------------------------------------+------------------------------------ Reporter: DaniilFrumin | Owner: jstolarek Type: bug | Status: closed Priority: low | Milestone: Component: Documentation | Version: 7.7 Resolution: fixed | Keywords: Operating System: Unknown/Multiple | Architecture: Unknown/Multiple Type of failure: None/Unknown | Difficulty: Unknown Test Case: | Blocked By: Blocking: | Related Tickets: -------------------------------------+------------------------------------ Changes (by jstolarek): * status: patch => closed * resolution: => fixed -- Ticket URL: http://ghc.haskell.org/trac/ghc/ticket/8201#comment:4 GHC http://www.haskell.org/ghc/ The Glasgow Haskell Compiler
participants (1)
-
GHC