API Docs

Overview

The API docs can be easily generated as follows:

Install PhpDocumentor:

$ pear install PhpDocumentor

From Seagull root:

$ phpdoc -d lib -f README.markdown -t docs --pear on -ric README.markdown --title "Seagull 2.0 API Docs" --output "HTML:Smarty:HandS"

To view on a Mac:

$ open docs/index.html

Also In This Series