Developer Documentation Structure

This developer's documentation is generated by phpDocumentor - a rather nifty open source documentation script for PHP (see phpdoc.org for more info). For those of you familiar with pre-1.4.6 versions of Form Tools, you may notice the commenting styles have changed in the core PHP code files (/global/code folder). The comments have been re-written to be compatible with phpDocumentor, allowing quick and easy auto-generation of commented source code.

The structure of the developer documentation is pretty straightforward, although the frames can be a little confusing at times; I'm sure you'll figure it out by clicking around for a while. The "DeveloperDoc" section - which you're in now and is found through the link on the top right of the screen - outlines the overall goals of the project, the various components, coding conventions and other general information.

The other sections of the developer doc are for the individual releases of Form Tools. Each one is allocated its own section (or "package" in phpDoc-speak), again found through links in the top right of the screen. The link name corresponds to the release version (e.g. 1-4-6 would be 1.4.6). These sections contain the full source code documentation for the Form Tools code library (i.e. the files in the /global/code/ folder) as well as a changelog to inform you of what has changed since the previous release. This changelog contains the same information as the changelog in the User Doc section, but it also includes more technical information about what changed, for the sake of programmers working with the code.