Re: HeaderDoc 7.2 bug found (and fix)
Re: HeaderDoc 7.2 bug found (and fix)
- Subject: Re: HeaderDoc 7.2 bug found (and fix)
- From: Bill Cheeseman <email@hidden>
- Date: Thu, 08 Jul 2004 09:06:26 -0400
Well, one fix is to upgrade to HeaderDoc 8.0b1 (I haven't tried 7.4.8 yet).
Now that Finlay showed me how to install it, I find that HeaderDoc 8.0b1
generates MUCH PRETTIER documentation than 7.2, and it fixes the category
and subclass bugs in 7.2, too.
There are still some bugs in the generated html, however, one of them
serious. For example:
1. The column spacing in the Classes section of the Contents is wrong. The
second column is indented too far to the right, by exactly the width of the
entry in the first column on the same line.
2. The link from every category method in the Contents to the corresponding
detail entry is broken.
3. HeaderDoc generates one or more incorrect detail entries for every method
that takes one or more parameters, as well as generating the correct entry.
Bug no. 3, above, makes HeaderDoc 8.0b1 useless for release documentation,
so I'll have to try 7.4.8 next -- which I understand is the latest "final"
version of HeaderDoc. Hopefully, it solves the category and subclass bugs in
7.2.
on 2004-07-08 7:40 AM, Bill Cheeseman at email@hidden wrote:
> The problems I've been having with HeaderDoc 7.2 seem to relate to the
> @category tag.
>
> If I remove the @category tag and all @method tags from all categories in a
> header, HeaderDoc generates correct documentation for all my headers and
> classes. As soon as I add one @category tag and one @method tag in a
> category, HeaderDoc generates documentation for the category but fails to
> generate any documentation for a class preceding the category in the header
> file. This is true whether the category is a category on the base class or a
> category on NSObject.
>
> Can anybody confirm this? And suggest a workaround so I can include my
> categories in my documentation? And tell me whether this is fixed in a later
> version of HeaderDoc?
--
Bill Cheeseman - email@hidden
Quechee Software, Quechee, Vermont, USA
http://www.quecheesoftware.com
The AppleScript Sourcebook - http://www.AppleScriptSourcebook.com
Vermont Recipes - http://www.stepwise.com/Articles/VermontRecipes
_______________________________________________
xcode-users mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/listinfo/xcode-users
Do not post admin requests to the list. They will be ignored.