• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: HeaderDoc alternative?
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: HeaderDoc alternative?


  • Subject: Re: HeaderDoc alternative?
  • From: Don Yacktman <email@hidden>
  • Date: Wed, 4 Jun 2003 09:48:48 -0600

On Wednesday, June 4, 2003, at 03:03 AM, Scott Anguish wrote:
On Wednesday, June 4, 2003, at 03:38 AM, Finlay Dobbie wrote:
On Wednesday, June 4, 2003, at 06:09 am, Mark Flider wrote:
Does anyone know of an alternative source-code-based documentation generator for Objective-C?

AutoDoc. It's on <http://softrak.stepwise.com>

however, it lives at http://www.clindberg.org

And on ftp.misckit.com

Autodoc has the advantage of being template driven, where HeaderDoc is tied to the perl code. HeaderDoc uses the headers for the info, but I think AutoDoc (and it has been YEARS since I last ran it) uses the .m files.

It actually parses both the .h AND the .m files. It is easy to add a new script build phase so you can easily have it be an automatic part of your PB build. It is also possible to create your own templates, so if you don't like the default ones (or want output in some other format) you can create and use your own.

However, while I think Autodoc is the best documentation solution for Objective-C, it doesn't do anything else. So the original poster's desires for class heirarchies, bugs, to-do lists, formatted source, etc. are NOT something Autodoc does. It is open source, and new versions do come out occasionally, so perhaps those things will be features in future versions. You can always suggest the ideas to Carl and see if he's willing or interested to add them. (But you might have more luck if you add the feature and submit it to Carl.)

--
Later,

Don Yacktman
email@hidden
_______________________________________________
cocoa-dev mailing list | email@hidden
Help/Unsubscribe/Archives: http://www.lists.apple.com/mailman/listinfo/cocoa-dev
Do not post admin requests to the list. They will be ignored.

References: 
 >Re: HeaderDoc alternative? (From: Scott Anguish <email@hidden>)

  • Prev by Date: Re: semantics of init
  • Next by Date: Re: Instantiating NSCells in Interface Builder
  • Previous by thread: Re: HeaderDoc alternative?
  • Next by thread: Instantiating NSCells in Interface Builder
  • Index(es):
    • Date
    • Thread