freshmeat.net entry
IDoc extracts interface documentation and declarations from Haskell modules based on standard Haskell layout rules and a small number of clues that the programmer embeds in interface comments. These clues have been designed to be visually non-imposing when displaying the source in a text editor. Interface documentation is rendered in standard markup languages (currently, only HTML is supported). IDoc has been designed to be simple to use and install.
You may want to have a look at a (somewhat silly) example of an IDoc-generated interface document. It
was generated from Foo.hs.
The latest news:
IDoc is written in plain Haskell 98, and thus, should work with any standards conforming Haskell system.
All features that were planned during initial system design are
implemented. The system has, however, only been tested lightly so far.
1These binaries are for glibc2.2-based Linux
systems (they were built on a Red Hat 7.2 system).
If you have any comments, suggestions, or a bug report, please let me know. Code contributions are
of course also welcome.
The code is released under the GNU General Public
Licence (GPL). This means that you can basically do with it what
you want as long as you contribute improvements to the tool itself
back to the community. Any documentation that you generate with the
tool is, however, free from any license restrictions from my side. The
situation is the same as with, say, the GNU C Compiler (gcc).
Last modified: 24 August 2009
Releases
idoc-0.2.6
[
tar.gz
|
i386.rpm
|
src.rpm
|
i386.deb
|
i386-unknown-linux.tar.gz
]idoc-0.2.5
[
tar.gz
|
i386.rpm
|
src.rpm
|
i386.deb
|
i386-unknown-linux.tar.gz
]
Feedback
License
This page is part of Manuel Chakravarty's
WWW-stuff.