Documentation Formatting

[aoberoi]

Currently, the generated reference documentation is a bit ugly. We use PHPDocumentor but its default template is pretty bad. This can be improved.

Wish list:

• runs in an automated fashion (perhaps as a post-commit hook)
• can be placed in a separate branch (gh-pages) can can be served statically
• should not disrupt the markdown parsing that is used to generate documentation on the website

[aoberoi]

@jeffswartz just wanted to start writing some things down from our previous discussions

[aoberoi]

Alternative documentation generators that may have cleaner and more acceptable default output:

• ApiGen (http://apigen.org/)
• Sami (https://github.com/fabpot/sami) - Symphony and Composer use this.

[aoberoi]

updated link for Sami: https://github.com/FriendsOfPHP/Sami