May 2002 - HaskellDoc

Haddock Parse Bugs
by Ashley Yakeley 05 May '02

05 May '02

I tried using Haddock on JVM-Bridge. It fails on empty datatypes: module HDTest where { data Foo; } It also fails on 'with' (for implicit parameters). 'with' is deprecated in 5.03, but its replacement syntax using 'let' won't work with 5.02.2. -- Ashley Yakeley, Seattle WA

1 0

Re: ANNOUNCE: Haddock version 0.1, a Haskell documentation tool
by Ashley Yakeley 03 May '02

03 May '02

At 2002-05-01 04:48, Simon Marlow wrote: >I'm pleased to announce version 0.1 of Haddock, a documentation >generation tool for Haskell source code. I take it this is the "standard" Haskell documentation tool now, that implementations of the standard libraries will use? I've been waiting for something like this. -- Ashley Yakeley, Seattle WA

1 0

ANNOUNCE: Haddock version 0.1, a Haskell documentation tool
by Simon Marlow 01 May '02

01 May '02

I'm pleased to announce version 0.1 of Haddock, a documentation generation tool for Haskell source code. It's available from http://www.haskell.org/haddock/ Here's the README: Haddock, a Haskell Documentation Tool ===================================== This is Haddock, a tool for automatically generating documentation from annotated Haskell source code. It is primary intended for documenting libraries, but it should be useful for any kind of Haskell code. Like other systems ([1],[2]), Haddock lets you write documentation annotations next to the definitions of functions and types in the source code, in a syntax that is easy on the eye when writing the source code (no heavyweight mark-up). The documentation generated by Haddock is fully hyperlinked - click on a type name in a type signature to go straight to the definition, and documentation, for that type. Haddock understands Haskell's module system, so you can structure your code however you like without worrying that internal structure will be exposed in the generated documentation. For example, it is common to implement a library in several modules, but define the external API by having a single module which re-exports parts of these implementation modules. Using Haddock, you can still write documentation annotations next to the actual definitions of the functions and types in the library, but the documentation annotations from the implementation will be propagated to the external API when the documentation is generated. Abstract types and classes are handled correctly. In fact, even without any documentation annotations, Haddock can generate useful documentation from your source code. Haddock can generate documentation in multiple formats; currently HTML is implemented, and there is partial support for generating DocBook. The generated HTML uses stylesheets, so you need a fairly up-to-date browser to view it properly (Mozilla, Konqueror, Opera, and IE 6 should all be ok). Full documentation can be found in the doc/ subdirectory, in DocBook format. Please send questions and suggestions to me: Simon Marlow <simonmar(a)microsoft.com> [1] IDoc - A No Frills Haskell Interface Documentation System http://www.cse.unsw.edu.au/~chak/haskell/idoc/ [2] HDoc http://www.fmi.uni-passau.de/~groessli/hdoc/

1 0