Re: Documentation generation
Excellent stuff thanks – hit a few bugs in it, but with some tweaking, its output looks absolutely brilliant. Cheers Tom Davie On 8 May 2011, at 14:11, Dave DeLong wrote: > AppleDoc produces Apple-like docsets: > > https://github.com/tomaz/appledoc > > Cheers, > > Dave > > Sent from my iPhone > > On May 8, 2011, at 4:42 AM, Thomas Davie wrote: > >> 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 (Cocoa-dev@lists.apple.com) >> >> 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: >> http://lists.apple.com/mailman/options/cocoa-dev/davedelong%40me.com >> >> This email sent to davedel...@me.com ___ Cocoa-dev mailing list (Cocoa-dev@lists.apple.com) 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: http://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com This email sent to arch...@mail-archive.com
Re: Documentation generation
AppleDoc produces Apple-like docsets: https://github.com/tomaz/appledoc Cheers, Dave Sent from my iPhone On May 8, 2011, at 4:42 AM, Thomas Davie wrote: > 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 (Cocoa-dev@lists.apple.com) > > 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: > http://lists.apple.com/mailman/options/cocoa-dev/davedelong%40me.com > > This email sent to davedel...@me.com ___ Cocoa-dev mailing list (Cocoa-dev@lists.apple.com) 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: http://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com This email sent to arch...@mail-archive.com
Documentation generation
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 (Cocoa-dev@lists.apple.com) 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: http://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com This email sent to arch...@mail-archive.com
