Problems with HeaderDoc 8.0 generating Objective C documentation
Problems with HeaderDoc 8.0 generating Objective C documentation
- Subject: Problems with HeaderDoc 8.0 generating Objective C documentation
- From: Ben Golding <email@hidden>
- Date: Tue, 24 Aug 2004 15:29:24 +1000
I've just been marking up a framework that I was going to release so
that it's documented. I had started with autodoc but changed to using
HeaderDoc. After doing that I'm quite puzzled, the documentation it
produces doesn't look much like rest of the documentation that comes
out of Apple which I'd like to emulate.
- I can't work out how to make a method name appear in italics in an
@description.
- A method signature is formatted freaklishly:
- ( id ) initWithFieldNames:
(NSArray *) fieldNames usingOptions:
(OCCSVOptions *) options;
where did all the extraneous spaces come from? Why aren't they used
consistently? Why break the argument names up on separate lines from
the arguments themselves?
- In the documentation (bottom of the page of "Tags for Objective C
Headers"), it mentions a directory of examples called "ExampleHeaders"
but I can't find this. Gee it would help.
- I'm really unclear about how to best add a documentation target to
Xcode to generate the documentation. I would have thought this would
be an obvious thing to document.
It seems obvious comparing what HeaderDoc is generating is not what
Apple are using for their documentation. What do Apple use internally?
Or do they keep their documentation separately from the source?
Ben.
_______________________________________________
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.