It is good practise to generate documentation for your project.

appledoc is a tool to help generating the HTML docs from your code.

This is a guide on how to do it.

Install VVDocumenter-Xcode

Firstly, install this Xcode plugin to help you with generating Javadoc style by simply typing /// (3 forward slashes).

git clone

Open the project and build.

Restart Xcode.

Typing /// above a method should now generate the template for you to document on a method.

Install appledoc

Install appledoc and build it.

git clone
sudo sh

Note: brew install appledoc doesn’t work with Yosemite as of April 2015, so git clone and build is the way to go.

Create a AppledocSettings.plist

You can refer to a basic use of appledoc at this point, but a basic use would have a number of parameters to the command.

It is better to create a plist to contain the parameters.

The default plist for a project is AppledocSettings.plist.

The plist for my project looks like this:

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
    <plist version="1.0">





I have some basic information about the project and the company. Then I am generating the HTML in Docs, without docset, and ignoring some folders such as Pods, tests and frameworks.

With that, in your project directory, run

appledoc .

That’s it!

The HTML will be in Docs.


There are some advanced commands and good guide about publishing from Cocoanetics.




Back to Home