Packages » Package freddy

Package freddy

Description:
Freddy is ideal tool to document your Freeform projects. It requires no document generation, everything is generated in real-time from the source files. Besides, it is the only tool that is able to generate documentation for PHP5 object-oriented features. Moreover, it will create links to classes or interfaces that are encountered in the @return or @param directives automatically. You can easily link to other methods, classes and packages from your doccomments, insert snips of PHP code that will be automatically highlighted with simple tags. And the most important feature - you can compose package-wide documentation and place it into the .freddy folder under your package main folder to have package description and other docs along with the class/package doccomments!

Note
Due to PHP bug 29268 in some situations Freddy will be unable to retrieve the class hint of a parameter; in such cases there will be a space in the method declaration


See also:

Authors:
  • Dennis Popel

Interfaces:
  • FreddyPlugin
    This interface allows you to create plugins for Freddy actions. These plugins are discovered via the SPI and executed on every invokation of the actions that extend Freddy base action. The plugins may modify the document variables, set their own templates etc.

Classes: