phpDocumentor docblocks -> API docs

[olleolleolle]

Would it be possible to start contributing changes to the code, for instance phpDocumentor docblocks?

If you don't know phpDocumentor:

• "The current standard auto-documentation tool for the php language".
• "A standalone auto-documentor similar to JavaDoc written in PHP"
• And: "Javadoc is a tool for generating API documentation in HTML format from doc comments in source code."

So, by using small "docblocks" like this, all code becomes easier to scan visually, and becomes possible to use auto-documenting tools on:

Code: Select all

/**
  * Returns an array of important information for given first name. 
  * Returns false on failure.
  * 
  * @param string $firstname  The firstname of the person to look up 
  * @return array Important info
  */

When you're done, you can run the phpDocumentor application on your PHP files, and have it create a full, hyperlinked webpage with the docs. It looks neat, and makes it easier to dive into the code and start hacking.