• 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
Documentation generation
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Documentation generation


  • Subject: Documentation generation
  • From: Thomas Davie <email@hidden>
  • Date: Sun, 08 May 2011 11:42:20 +0100

Heya,

I'm working on improving my CoreParse (http://www.github.com/beelsebob/CoreParse) framework by actually documenting it properly.  The problem I'm hitting though is that either the two major documentation generators suck (doubt that, probably PEBKAC), or their default configuration sucks.  I've had a go with both doxygen and headerdoc.

Headerdoc seems to produce some reasonably clear and well organised output, but I can't find any way to configure the output to be a bit prettier.

Doxygen seems to produce a pretty cluttered mess as output, with a bunch of stuff that I really don't want, but I've not found any good documentation on how to configure it to produce nicer output.  The GUI tool seems to be a perfect example of how not to design a GUI wrapper for a command line tool.  Perhaps the design skills involved in it hint at why I don't like the structure of it's output either.

Does anyone know a good way to get clean, reasonably configurable html output for objective-c documentation?  Ideally, I'd like something that just dumps out almost exactly the style apple use for their docs, without too much need to play about.

Thanks

Tom Davie_______________________________________________

Cocoa-dev mailing list (email@hidden)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:

This email sent to email@hidden

  • Follow-Ups:
    • Re: Documentation generation
      • From: Dave DeLong <email@hidden>
  • Prev by Date: Re: NSTextView and NSTextContainer size & clipping area
  • Next by Date: Re: Communicate Between CocoaAsyncSocket and Java Socket
  • Previous by thread: Getting NSWindow's contentBorderThickness working on a transparent window
  • Next by thread: Re: Documentation generation
  • Index(es):
    • Date
    • Thread