iOS Development Series — I

Custom Doc for Xcode and the Web

With the release of Xcode 5, generating and integrating your custom documentation into Xcode or publishing it to the web has become incredibly easy.

Here’s what you need to do to get up and running.

• Install appledoc using Homebrew
  $ brew install appledoc
• Generate your DocSet for Xcode. The only required options are -p for your project name and -c for your company name. For example, for my project called Base, assuming I’m in my project’s root directory and that it has a doc directory:
  $ appledoc -p Base -c Ratsimihah Base

Proper doc, the Apple way. right in your IDE!

• Alternatively, generate the html doc for your website using the
  —keep-intermediate-files flag:
  $ appledoc -p Base -c Ratsimihah —keep-intermediate-files Base
  It generates your doc in a html directory, but you can also use the -o option to specify a different output directory.

On the web too!

And that’s all there is to it. Kinda. Actually, there’s a lot more you can configure. Check out:
$ appledoc —help

Cheers!

What, you don’t know Javadoc or its syntax? No worries! @mattt’s got your back!