Aloha!Thanks to Ian, GHC now uses Cabal for most of its work. As a result Haddock now Just Works (tm). With my patches (which Ian just committed) we can now run Haddock on GHC and can get such nice html pages like [1]. The goal is now to keep it working. :)
I had to find some rather tricky problems, so I documented them on the wiki [2]. I hope that this page will also develop into some general guidelines for how detailed the Haddock comments should be. Personally, I wouldn't mind if much of the commentary could move into haddock documentation. At the very least we could start building the documentation in regularly and include links in the commentary.
It's going to take a while until, though, until most of GHC is documented well. I "Haddock-enabled" ("haddockised"? "haddockified"?) "DynFlags" and there're lots of undocumented parts left and I believe there aren't that many persons that could document them.
Nevertheless, this is a good start to even more accessible GHC source code.
/ ThomasPS: Looking at <http://code.haskell.org/~nominolo/html/ghc/> it might be a not be a bad idea to switch to hierarchical modules some time now. Thoughts?
[1]: http://code.haskell.org/~nominolo/html/ghc/GHC.html [2]: http://hackage.haskell.org/trac/ghc/wiki/HaddockNotes -- Once upon a time is now.
PGP.sig
Description: This is a digitally signed message part
_______________________________________________ Cvs-ghc mailing list [email protected] http://www.haskell.org/mailman/listinfo/cvs-ghc
