ZenMagick API

From ZenMagick Wiki

Jump to: navigation, search

About

The documentation of the ZenMagick API is done using the excellent PHPDoctor.

In short, the way it works is that PHPDoctor will analyze all .php files and search for (specially formated) comments. Those are used to build the API references.

Where is it?

http://www.zenmagick.org/apidocs

Finding Things

All code is organized into packages. Ideally, those packages will contain functions, constants and classes that are somehow related.

All packages use the common prefix org.zenmagick

There is a simple custom PHP script that allows to jump to individual classes or packages by adding a class or package parameter to the URL. Furthermore, URL rewriting is enabled to make URLs look nicer and easier to write.

Some examples:

This syntax is not only useful to find things, but also makes linking to specific classes or packages easy.

Retrieved from "http://wiki.zenmagick.org/index.php/ZenMagick_API"
Personal tools