| IDoc - A No Frills Haskell Interface Documentation System |
Manuel M T Chakravarty,
chak@cse.unsw.edu.au
|
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.
The documentation is split into three parts:
Netscape navigator seems to have problems with the vertical spacing of
tables that contain <pre> tags, which IDoc uses to
markup multi-line interfaces declarations. My tip: Dump Netscape and
use a decent browser such as Mozilla
or Galeon.
IDoc - A No Frills Haskell Interface Documentation System Copyright (C) 2002 Manuel M T Chakravarty This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.