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.
Firstly, install this Xcode plugin to help you with generating Javadoc style by simply typing
/// (3 forward slashes).
git clone https://github.com/onevcat/VVDocumenter-Xcode.git
Open the project and build.
/// above a method should now generate the template for you to document on a method.
Install appledoc and build it.
git clone https://github.com/tomaz/appledoc.git sudo sh install-appledoc.sh
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
The plist for my project looks like this:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <plist version="1.0"> <dict> <key>--project-name</key> <string>Jade</string> <key>--project-company</key> <string>Just2us</string> <key>--company-id</key> <string>com.justus</string> <key>--output</key> <string>Docs</string> <key>--create-docset</key> <false/> <key>--ignore</key> <array> <string>Pods</string> <string>Libs</string> <string>JadeTests</string> <string>*.framework</string> </array> </dict> </plist>
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
The HTML will be in
There are some advanced commands and good guide about publishing from Cocoanetics.