Difference between revisions of "Haddock/FAQ"

From HaskellWiki
Jump to navigation Jump to search
(better FAQ format)
Line 1: Line 1:
* My version of Haddock does not accept some infix operators like <hask>(#)</hask>.
+
=== My version of Haddock does not accept some infix operators like <hask>(#)</hask> ===
   
: In fact it does, but you have to add spaces between parentheses and the infix symbols sometimes: <hask>( # )</hask>.
+
In fact it does, but you have to add spaces between parentheses and the infix symbols sometimes: <hask>( # )</hask>.
   
* How do I get hyperlinks to definitions in e.g. Haskell98?
+
=== How do I get hyperlinks to definitions in e.g. Haskell98? ===
   
: You must have the relevant documentation installed e.g. ghc-doc. Then you can say e.g.:
+
You must have the relevant documentation installed e.g. ghc-doc. Then you can say e.g.:
: <pre> haddock</pre>
+
<pre> haddock</pre>
: <pre>-odir=haddock --html</pre>
+
<pre>-odir=haddock --html</pre>
: <pre>--read-interface=http://www.haskell.org/ghc/docs/latest/html/libraries/base,/usr/share/doc/packages/ghc-doc/libraries/base/base.haddock</pre>
+
<pre>--read-interface=http://www.haskell.org/ghc/docs/latest/html/libraries/base,/usr/share/doc/packages/ghc-doc/libraries/base/base.haddock</pre>
: <pre>--read-interface=http://www.haskell.org/ghc/docs/latest/html/libraries/haskell98,/usr/share/doc/packages/ghc-doc/libraries/haskell98/haskell98.haddock</pre>
+
<pre>--read-interface=http://www.haskell.org/ghc/docs/latest/html/libraries/haskell98,/usr/share/doc/packages/ghc-doc/libraries/haskell98/haskell98.haddock</pre>
: <pre>Data/LargeWord.hs</pre>
+
<pre>Data/LargeWord.hs</pre>
  +
: or much easier just use cabal: <pre>./Setup haddock</pre>
+
or much easier just use cabal:
  +
  +
<pre>./Setup haddock</pre>

Revision as of 14:08, 21 August 2009

My version of Haddock does not accept some infix operators like (#)

In fact it does, but you have to add spaces between parentheses and the infix symbols sometimes: ( # ).

How do I get hyperlinks to definitions in e.g. Haskell98?

You must have the relevant documentation installed e.g. ghc-doc. Then you can say e.g.:

 haddock
-odir=haddock --html
--read-interface=http://www.haskell.org/ghc/docs/latest/html/libraries/base,/usr/share/doc/packages/ghc-doc/libraries/base/base.haddock
--read-interface=http://www.haskell.org/ghc/docs/latest/html/libraries/haskell98,/usr/share/doc/packages/ghc-doc/libraries/haskell98/haskell98.haddock
Data/LargeWord.hs

or much easier just use cabal:

./Setup haddock