API Docs

Contents

• 2_0/ApiDocs API Docs
• 2_0/AutoLoading Autoloading Support
• 2_0/EventsAndPlugins Using the Event component
• 2_0/Overview Overview Seagull 2.0
• 2_0/UnitTests Unit Tests

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