appledoc Exception: at least one directory

Question

After wasting some time to figure out what goes wrong, I finally have to ask for help. I want to use appledocs from Gentle Bytes. I followed every step of the quick install guide, but I´m not able to compile the project.

Here is what I´ve done: 1. cloned it from git://github.com/tomaz/appledoc.git 2. installed the templates to ~/Library/Application Support/appledoc 3. tried to compile the project

Everytime I try to compile, I get following error: ERROR: AppledocException: At least one directory or file name path is required, use 'appledoc --help'

What do I have to do now?

Answer 1

Sounds like you've compiled it just fine and are now running the program. If it's a command-line program try command-option-R in Xcode to provide some arguments (i.e. names of files that you want to process).

Answer 2

The error means you didn't give it source paths: after all switches, you must give it at least one path to your source files. Can be either file or directory. In later case it will recursively scan the dir. Here's example

appledoc <options> ~/MyProject

Above example will use ~/MyProject directory as a source. You can also add multiple source paths. Note that you need to give the tool few options, see this page for minimum command line and other usage examples.

You either have to copy appledoc executable to one of directories in your path, as suggested by Caleb, or use full path to it when invoking (for example: /path/to/appledoc)