This page is about the documentation of Grabbl (both API and user manual). For the documentation itself, please refer to the main website.

API documentation

The code of Grabbl is documented using phpDocumentor based on comments in the source files.

Generating Grabbl documentation with phpDocumentor

The Grabbl documentation is best generated using phpDocumentor via the commandline interface. To use it, you'll need the following:

• phpDocumenter (1.3.1 or higher)
• PHP5 CLI

The documentor files can be downloaded from its website. Extract them to a convenient location. Installing the PHP5 commandline interface on Linux can be done with your favourite package manager. For Windows (not really recommended) you can install pre-compiled binaries provided on the PHP website.
On Debian-based systems, simply apt-get the packages you need. For Ubuntu this will be:

$ sudo apt-get install php5-cli

Next step is to add some files to phpDocumentor. You will need the customised template and a configuration file:

• Download grabbl-smarty.tar.gz and extract it to the folder that contains the phpdoc file (the archive uses the right file structure, so the template will end up in the right folder)
• Download grabbldoc.ini and put it in the user folder (which is located inside the phpDocumentor installation directory)

You will need to open the .ini file in a text editor and change lines 21 and 25 to reflect the locations you are using. Now open a terminal (if you haven't already done so) and cd to the phpDocumentor directory. Make the phpdoc file executable:

$ chmod +x ./phpdoc

Finally, you can generate the documentation:

$ ./phpdoc -c grabbldoc

If you are having problems, please verify that you have everything installed and that the directories on lines 21 and 25 in grabbldoc.ini exist and are writable.