From f50bd85da2d7edd5c9444cb3aaf5680961103928 Mon Sep 17 00:00:00 2001 From: panne Date: Mon, 2 Aug 2004 18:17:46 +0000 Subject: [haddock @ 2004-08-02 18:17:46 by panne] Mainly DocBook fixes --- doc/haddock.sgml | 287 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 180 insertions(+), 107 deletions(-) (limited to 'doc/haddock.sgml') diff --git a/doc/haddock.sgml b/doc/haddock.sgml index 3d355d9b..b0e4204f 100644 --- a/doc/haddock.sgml +++ b/doc/haddock.sgml @@ -2,7 +2,7 @@ - 2002-4-10 + 2004-08-02 Haddock User Guide Simon @@ -100,7 +100,7 @@
Obtaining Haddock - Distributions (source & binary) of Haddock can be obtained + Distributions (source & binary) of Haddock can be obtained from its web site. @@ -202,13 +202,13 @@ haddock - option - file + option + file Where each file is a filename containing a Haskell source module. Only plain Haskell source - files are accepted (but see for instructions + files are accepted (but see for instructions on how to pre-process source files for feeding to Haddock). All the modules specified on the command line will be @@ -229,10 +229,14 @@ - dir - =dir - - + + + dir + + + + =dir + Generate files into dir instead of the current directory. @@ -240,10 +244,14 @@ - path,file - =path,file - - + + + path,file + + + + =path,file + Read the interface file in file, which must have been @@ -269,11 +277,14 @@ - file - =file - - - + + + file + + + + =file + Produce an interface fileHaddock interface files are @@ -289,21 +300,28 @@ - dir - =dir - - - + + + dir + + + + =dir + Use auxiliary files in dir. - - - - + + + + + + + + Reserved for future use (output documentation in SGML DocBook format). @@ -311,10 +329,14 @@ - - - - + + + + + + + + Generate documentation in HTML format. Several files will be generated into the current directory (or the @@ -367,14 +389,18 @@ - - - - + + + + + + + + (In HTML mode only) Produce extra contents and index files for given HTML Help system. Currently supported Help - systems are Microsoft HTML Help 1.3 and 2.0 and GNOME DevHelp. + systems are Microsoft HTML Help 1.3 and 2.0 and GNOME DevHelp. Using the Microsoft HTML Help system provides two advantages over plain HTML: the help viewer gives you a nice @@ -389,24 +415,24 @@ http://www.microsoft.com/ (search for HTML Help compiler). - Viewers + Viewers - - Microsoft HTML Help Viewer - Distributed with Microsoft Windows - - - xCHM - a CHM viewer for UNIX (Linux, *BSD, Solaris), written by Razvan Cojocaru - - - JouleData Solutions' CHM Viewer - a comercial 100% native Cocoa .chm file viewer for the Mac OS X platform - - - GnoCHM - a CHM file viewer. It is designed to integrate nicely with Gnome. - + + Microsoft HTML Help Viewer + Distributed with Microsoft Windows + + + xCHM + a CHM viewer for UNIX (Linux, *BSD, Solaris), written by Razvan Cojocaru + + + JouleData Solutions' CHM Viewer + a comercial 100% native Cocoa .chm file viewer for the Mac OS X platform + + + GnoCHM + a CHM file viewer. It is designed to integrate nicely with Gnome. + The GNOME DevHelp also provides help viewer which looks like @@ -422,10 +448,14 @@ - URL - =URL - - + + + URL + + + + =URL + Include links to the source files in the generated documentation, where URL is the @@ -434,9 +464,14 @@ - file - =file - + + + file + + + + =file + Specify a stylesheet to use instead of the default one that comes with Haddock. It should specify certain classes: @@ -445,10 +480,14 @@ - file - =file - - + + + file + + + + =file + Specify a file containing documentation which is placed on the main contents page under the heading @@ -459,10 +498,14 @@ - title - =title - - + + + title + + + + =title + Use title as the page heading for each page in the documentation.This will @@ -474,11 +517,14 @@ - - - - - + + + + + + + + Don't automatically import Prelude in every module. Used when producing documentation for the @@ -487,32 +533,42 @@ - - - - + + + + + + + + Produce extra debugging output. - - - - + + + + + + + + Display help and exit. - - - - - - + + + + + + + + Increase verbosity. Currently this will cause Haddock to emit some extra warnings, in particular about modules @@ -523,18 +579,24 @@ - - - - + + + + + + + + Output version information and exit. - - + + + + When generating HTML, do not generate an index. Instead, redirect the Index link on each page to @@ -546,8 +608,10 @@ - - + + + + Generate an HTML index containing entries pulled from all the specified interfaces (interfaces are specified using @@ -558,11 +622,14 @@ - P - P - - - + + + P + + + + P + Set the package name for these modules to P. In a combined index generated @@ -919,7 +986,7 @@ import C (a, b) The exception to this rule is when the re-exported module is declared with the hide attribute - (), in which case the module + (), in which case the module is never cross-referenced; the contents are always expanded in place in the re-exporting module.
@@ -1086,8 +1153,10 @@ module A where - hide - hide + + hide + hide + Omit this module from the generated documentation, but nevertheless propagate definitions and documentation @@ -1097,8 +1166,10 @@ module A where - prune - hide + + hide + prune + Omit definitions that have no documentation annotations from the generated documentation. @@ -1106,8 +1177,10 @@ module A where - ignore-exports - hide + + hide + ignore-exports + Ignore the export list. Generate documentation as if the module had no export list - i.e. all the top-level -- cgit v1.2.3