Documenting Obj-C code
Documenting Obj-C code
- Subject: Documenting Obj-C code
- From: Ronald Hayden <email@hidden>
- Date: Mon, 26 Nov 2001 12:24:15 -0800
Date: Mon, 26 Nov 2001 10:26:52 -0800
Subject: Documenting Obj-C code
From: "Josh Braun" <email@hidden>
To: email@hidden
Is there any way to document Objective-C code similar to the javadoc
method in Java? How do most folks document their code? Was the Cocoa
API documentation prepared purely by hand?
The Cocoa API doc does not currently use any kind of JavaDoc-like
functionality. However, Apple does have HeaderDoc for C and C++, and we
have a first pass of Objective-C functionality in place. I'm not sure
if the Objective-C support is downloadable yet (I'll check on that
today), but you can find out about HeaderDoc, an Open Source tool, at:
http://www.opensource.apple.com/projects/headerdoc/
-- Ron Hayden, doc tools manager