darcs patch: Allow referring to a specific section within a module ...

Fri Nov 28 00:27:36 EET 2008  Roman Cheplyaka <roma <at> ro-che.info>
  * Allow referring to a specific section within a module in a module link
  Fixes #65

_______________________________________________
HaskellDoc mailing list
HaskellDoc <at> haskell.org
http://www.haskell.org/mailman/listinfo/haskelldoc

Unacceptable result type in FFI

How do you get Haddock 2.4 to handle the return type of an FFI function 
that isnt "IO". It works automatically in the haddock version that ships 
with ghc 6.8.1.

I tried:

haddock --haddock-options=--optghc=-XGeneralizedNewtypeDe
riving

ANNOUNCE: Haddock version 2.4.0

--------------------------------------------
-- Haddock 2.4.0
--------------------------------------------

A new version of Haddock, the Haskell documentation tool, is out.

This is a later version than the one shipped with GHC 6.10.1, which is version
2.3.0. That version will not be released on Hackage since it only builds with
GHC 6.10.1 (by accident, actually).

Besides adding back support for earlier GHC versions, this release contains
some more fixes and support for HTML frames.

Please use the bug tracker to submit bug reports or feature requests.

--------------------------------------------
-- Changes in version 2.4.0
--------------------------------------------

  * Add framed view of the HTML documentation

  * Build with GHC 6.8.2 and 6.8.3 again

  * Support images in documentation comments again

  * Small improvements to the Hoogle output

  * A few bugs has been fixed

--------------------------------------------

ANN: Haddock version 2.2.1

--------------------------------------------
-- Haddock 2.2.1
--------------------------------------------

A new version of Haddock, the Haskell documentation tool, is out.

The homepage will be updated soon, containing a windows binary release.

Please use the bug tracker to submit bug reports and feature requests.

--------------------------------------------
-- Changes since version 2.1.0
--------------------------------------------

 * Support for GHC 6.8.3

 * The Hoogle backend is back

 * Show associated types in the documentation for class declarations

 * Show type family declarations

 * Show type equality predicates

 * Major bug fixes (#1 and #44)

 * It is no longer required to specify the path to GHC's lib dir

 * Remove unnecessary parenthesis in type signatures

Type Families in Haddock

Hi,

I'm going to add Type Families support to the Haddock HTML backend.
What would be the best way to do it? I'm thinking it could work
similar to how classes and instances are currently rendered, so that
type/data/newtype instances are collected and attached to type family
declarations. Is this too simplistic? Should we render
type/data/newtype instances as separate entities in the module
documentation instead (and perhaps do the same thing with class
instances)?

Currently, when packages export instances that belong to classes from
other packages, those instances are not documented anywhere. An
advantage of having instances as separate entities in the exporting
module documentation is that no instances are "lost".

David

ANN: Haddock Trac

Hi everyone,

there's now a Haddock bug-tracker and wiki at
http://trac.haskell.org/haddock. Please use it to submit bug reports
and feature requests!

David

Re: Haddock 2.0.0.0 Bug: Doesn't Like {;}-Style Code

> I wrote:
>> Try running haddock on this:
>>
>> module HaddockBug where
>> {
>> -- |The 'square' function squares an integer.
>> square :: Int -> Int;
>> square x = x * x;
>> }
>>
>> $ haddock -B /usr/lib/ghc-6.8.2/ HaddockBug.hs
>>
>> HaddockBug.hs:4:0: parse error on input `square'
>> haddock: Failed to load all needed modules
>>
>> It works fine if you remove the haddock comment...
>
> I discovered a work-around: put a semicolon after the haddock comment.
>
> module HaddockBug where
> {
> -- |The 'square' function squares an integer.
> ;
> square :: Int -> Int;
> square x = x * x;
> }
>
> --
> Ashley Yakeley
> Seattle, WA

Haddock 2.0.0.0 Bug: Doesn't Like {;}-Style Code

Try running haddock on this:

module HaddockBug where
{
-- |The 'square' function squares an integer.
square :: Int -> Int;
square x = x * x;
}

$ haddock -B /usr/lib/ghc-6.8.2/ HaddockBug.hs

HaddockBug.hs:4:0: parse error on input `square'
haddock: Failed to load all needed modules

It works fine if you remove the haddock comment...

--

-- 
Ashley Yakeley
Seattle, WA

Fwd: Haddock GADTs Hack

Forwarding since my first post was rejected:

>
> Från: David Waern <davve <at> dtek.chalmers.se>
> Datum: onsdag 7 feb 2007 11.40.36 GMT+01:00
> Till: Simon Peyton-Jones <simonpj <at> microsoft.com>
> Kopia: Ashley Yakeley <ashley <at> semantic.org>,  
> "haskelldoc <at> haskell.org" <haskelldoc <at> haskell.org>
> Ämne: Re: Haddock GADTs Hack
>
>
>
> 7 feb 2007 kl. 09.42 skrev Simon Peyton-Jones:
>
>> Great stuff.   However, David Waern's SoC project is very nearly  
>> at the point where he can generate Haddock for anything GHC  
>> understands; he's using GHC itself as the front end.
>>
>> He's recently added the rendering code for GADTs I think.  I think  
>> he's probably planning a release shortly.  David?
>>
>> Meanwhile Ashley's hack may well prove useful.
>>
>> Simon
>
> Hi,
>
> It's hard for me to make a release when GHC 6.8 is not out. But  
> I'll try to come up with some wiki page that describes Haddock-GHC  
> and how to use it with GHC HEAD.

Haddock GADTs Hack

Included is a hack to allow haddock to parse GADTs. There are two 
problems with it:

1. I don't think you can add doc comments to the constructors.

2. The shown types are wrong: the whole type of the constructor is shown 
as if it were the type of a single argument. Fixing this will presumably 
involve adding another constructor to HsConDecl to represent GADT 
constructors.

It wouldn't be appropriate to release haddock in this state, but I think 
it's helpful for those of us who could get no doc at all just because we 
have a GADT in our code.

--

-- 
Ashley Yakeley
Seattle, WA

New patches:

[hack to parse GADTs, though with incorrect constructor types
Ashley Yakeley <ashley <at> semantic.org>**20070207070109] {
hunk ./src/HsParser.ly 480
+> 	  | 'where' gadtconstrlist    { addConDocs $2 Nothing }
hunk ./src/HsParser.ly 497
+> gadtconstrlist :: { [HsConDecl] }
+>	: '{' gadtconstrs '}'			{ $2 }
+>	|     layout_on  gadtconstrs close	{ $2 }

Haddock 0.8 question

Greetings, list,

I just downloaded and compiled Haddock 0.8.  I still seem to be
running into a couple of issues, namely:

* The parser gags on the identifier ##,
* and on generalized algebraic data types.

Am I missing an obvious configuration switch, workaround, etc.?

 /g