Re: HeaderDoc 7.2 bug found (and workaround)
Re: HeaderDoc 7.2 bug found (and workaround)
- Subject: Re: HeaderDoc 7.2 bug found (and workaround)
- From: Bill Cheeseman <email@hidden>
- Date: Thu, 08 Jul 2004 08:37:27 -0400
The bug seems to be a little more complex than I originally posited.
A workaround is to omit the @category tag but include @method tags for all
of the methods in the category. HeaderDoc 7.2 then blows right past the base
class's @end and includes the category methods in the base class
documentation. This is what the HeaderDoc docs say the @category tag is
supposed to do anyway, so that's ok.
However, if the next @interface found in the header file is a subclass of
the base class, HeaderDoc 7.2 generates documentation for the subclass but
ignores the base class. If I employ a similar workaround, omitting the
@class tag for the subclass but including @method tags for all of the
subclass's methods, HeaderDoc generates documentation for the base class
that includes all of the base class, category and subclass methods. This is
not satisfactory, of course, but it is better than not documenting these
methods at all.
Again, is any of this fixed in later releases of HeaderDoc?
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.
>
--
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.