#appledoc

[tonyhadisiswanto]

Amazing Apple-like Documentation

I know I know, Documentation is a bad bad word, especially for us creative people. The true creativity is in writing code, not in writing comments, isn't it? Well, regardless, you might find yourse...

Create Your Code Documentation like Apple Doc

[pocketfoo-blog-blog]

VVDocumenter-Xcode

VVDocumenter-Xcode - Xcode plug-in which helps you write Javadoc style documents easier.

Writing document is so important for developing, but it is really painful with Xcode. Think about how much time you are wasting in pressing '*' or '/', and typing the parameters again and again. Now, you can find the method (or any code) you want to document to, and type in ///, the document will be generated for you and all params and return will be extracted into a Javadoc style, which is compatible with appledoc, Doxygen and HeaderDoc. You can just fill the inline placeholder tokens to finish your document.

[bolnad]

__block variables

Two rules pertaining to this, from the apple docs...

 __block variables: they cannot be variable length arrays, and cannot be structures that contain C99 variable-length arrays.

there you have it, in case you were wondering

[xtremelabsinc-blog]

Appledoc

Good documentation goes a long way towards, not only helping others understand your code, but also simplifying re-use. Unfortunately, it seems that the moment documentation is written, it’s out-of-date from the code, especially if maintained separately in its own document. Read More - http://tech.xtremelabs.com/appledoc/

[orhunt]

appledoc build script

/usr/local/cellar/appledoc/2.0.4/bin/appledoc --project-name $PROJECT_NAME --project-company "Company Name" --company-id com.company --output $SOURCE_ROOT/docs --logformat Xcode .

Add it as a Build Phase to have documentation generated each time you build. I've got this set up on a separate 'Documentation' target so it doesn't run every single time. That way, each build isn't slowed down by documentation generation.

(I have my appledoc installed under homebrew, hence the path.)