From e8acc1e6201cd3b99b41bb1eb3171ebfba5b443c Mon Sep 17 00:00:00 2001 From: simonmar Date: Wed, 10 Jul 2002 10:57:10 +0000 Subject: [haddock @ 2002-07-10 10:57:10 by simonmar] Document all the new options since 0.3 --- doc/haddock.sgml | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) (limited to 'doc/haddock.sgml') diff --git a/doc/haddock.sgml b/doc/haddock.sgml index f4937153..d87aa4af 100644 --- a/doc/haddock.sgml +++ b/doc/haddock.sgml @@ -235,6 +235,24 @@ + + =file + + + + Produce an interface + fileHaddock interface files are + not the same as Haskell interface files, I just couldn't + think of a better name. + in the file file. An interface + file contains information Haddock needs to produce more + documentation that refers to the modules currently being + processed - see the option + for more details. The interface file is in a binary format; + don't try to read it. + + + @@ -284,6 +302,72 @@ + + path,file + =path,file + + + + Read the interface file in + file, which must have been + produced by running Haddock with the + option. The interface + describes a set of modules whose HTML documentation is + located in path (which may be a + relative pathname). The path is + optional, and defaults to .. + + This option allows Haddock to produce separate sets of + documentation with hyperlinks between them. The + path is used to direct hyperlinks + to point to the right files; so make sure you don't move the + HTML files later or these links will break. Using a + relative path means that a + documentation subtree can still be moved around without + breaking links. + + Multiple options may + be given. + + + + + + + + + (In HTML mode only) Produce extra contents and index + files for the Microsoft HTML Help system. The files created + will be named index.hhc and + index.hhk respectively. + + Using the Microsoft HTML Help system provides two + advantages over plain HTML: the help viewer gives you a nice + hierarchical folding contents pane on the left, and the + documentation files are compressed and therefore much + smaller (roughly a factor of 10). The disadvantages are + that the viewer is only available on Windows, and the help + can't be viewed over the web. + + In order to create a compiled Microsoft help file, you + also need the Microsoft HTML Help compiler, which is + available free from http://www.microsoft.com/ + (search for HTML Help compiler). + + + + + + + + + Don't automatically import Prelude + in every module. Used when producing documentation for the + Prelude itself. + + + dir =dir @@ -295,6 +379,20 @@ + + file + =file + + + + Specify a file containing documentation which is + placed on the main contents page under the heading + “Description”. The file is parsed as a normal + Haddock doc comment (but the comment markers are not + required). + + + URL =URL -- cgit v1.2.3