|Jul 27, 2007, 05:52 PM||#1|
I have realised that the source code for my application is well, very poor, so I've been trying to get my documentation up to scratch, I tried using HeaderDoc, but Apple seem to have abandoned it and it is very buggy (it adds a month to dates, so thinks today is the 27th August) and it is difficult to get to parse the code.
Anyhow what can I use? I am programming in Objective C so sadly (I guess) can't use Javadoc, which is excellent.
EDIT: Attached is the relevent header file, and the documentation folder in a zip, apart from the dates I may be being a little unfair about HeaderDoc so I'll take another look tomorrow, but good documentation comments are still welcome.
Last edited by Eraserhead; Jul 27, 2007 at 06:09 PM. Reason: Adding attachment/edit
|Jul 27, 2007, 06:24 PM||#2|
Beyond that, it is useful to have documentation that explains how a class is used. Automatic tools usually don't do that, because they just document individual functions. And as I said, with well-written code that kind of documentation doesn't add very much.
|Thread Tools||Search this Thread|
|thread||Thread Starter||Forum||Replies||Last Post|
|Mavericks Documentation||Dj64Mk7||OS X Mavericks (10.9)||2||Jan 17, 2014 05:51 PM|
|Thunderbolt 2 shown in documentation||arnistotle2000||MacBook Air||6||Dec 8, 2013 11:30 AM|
|Documentation for IOS 7?||hakr100||iOS 7||2||Sep 12, 2013 09:21 PM|
|Xcode 4.5.2 and C++ documentation||Adrian00||Mac Programming||3||Dec 10, 2012 01:01 PM|
|iOS6 Documentation Download||krayziekray||iPhone/iPad Programming||3||Jun 18, 2012 02:46 AM|
All times are GMT -5. The time now is 11:22 PM.