how to use appledoc to generate an Apple-like documentations

tranvutuan picture tranvutuan · Mar 21, 2012 · Viewed 11.8k times · Source

I am reading on the article how to generate an Apple-like HTML documentation at here. My questions are what the command lines are used for. How can we combine command lines and appledoc xcode project to generate a HTML.

Answer

Tom picture Tom · Mar 27, 2012

I'm the author of appledoc tool. The tool is intended to be used as answered by Caleb above. Recommended installation method is to clone repository from GitHub, open project in Xcode, build and optionally copy binary to your path as suggested above. Additionally, you must also copy template files required for running the tool to one of predefined paths. All the steps required are described in the readme file on appledoc page on GitHub, see Quick Install section.

There are also other methods for installing - all contribution from users:

  • You can use install-appledoc.sh script included in the git repository.
  • There's also homebrew recipe available, although it doesn't install template files to my understanding (see this link).

For any additional questions go to appledoc Google group. I just created it few days ago, so there's no content at the moment of this writing, but feel free to ask questions there.