Re: Source code documentation systems for Cocoa (and C)
Re: Source code documentation systems for Cocoa (and C)
- Subject: Re: Source code documentation systems for Cocoa (and C)
- From: "Mark J. Lilback" <email@hidden>
- Date: Tue, 2 Dec 2003 09:23:44 -0800 (PST)
Patrick Machielse <email@hidden> wrote:
>
But there are also plenty of downsides:
>
>
- ignores C api. (n.b. I updated the message subject)
>
- no frames in html output.
I think of that as a good thing.
>
- no table of contents, just a bunch of .html files?
The last points could conceivably be solved by some clever post processing
code.
>
Also, the program has not been updated for 2.5 years. (tested on OS X public
>
beta?) so there seems to be little hope for improvement.
Since source code is available, that shouldn't be an issue. I heavily modified it for my own uses, adding:
1) support for delegates, notifications, and protocols
2) a meta tag to add to documentation to turn off HTML escaping (so you can embed HTML)
3) support for only generating documentation for header files marked Public in a specified pbproj (haven't tried it with a native Xcode target).
4) support for generating a table of contents
5) modified templates that generate output 99% identical to the Cocoa documentation
Some of my methods are very hackish and they break support
for other output formats, but it does what I need. I wrote
to Carl about them, but he'd had another patch for delegate
support and wanted to think over the best way to do it. My
way is probably far from the best, but it works, which is
all I care about.
If anyone is interested, I can post my modified version.
--
__________________________________________________________________________
"They that can give up essential liberty
Mark J. Lilback to obtain a little temporary safety
<email@hidden> deserve neither liberty or safety."
http://www.lilback.com/ -- Benjamin Franklin
_______________________________________________
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.