Fixes #10 : documentation clean-up post refactor.
Note that phpDocumentor2 is generating a host of spurious errors in my
environment which may be hiding actual issues. The generated HTML also has
issues in chrome which make it hard to browse and that also may be covering up
problems in this commit.
However, I cleaned up and fixed a number of doc-comment issues, ensured that
most methods/properties had reasonable descriptions and noted preconditions.
Eclipse is browsing the comments and picking up on type hints without the
problems phpDocumentor2 is showing.
I also updated the README.