search

j4mie / idiorm

A lightweight nearly-zero-configuration object-relational mapper and fluent query builder for PHP5.
http://j4mie.github.com/idiormandparis/
2.01k stars 369 forks source link

PHPdocs #148

Closed michaelward82 closed 11 years ago

michaelward82 commented 11 years ago

I would like see Idiorm and Paris documented with the PHPDoc standard (http://www.phpdoc.org/).

The libraries are currently well documented, but in a fashion that doesn't help much where an IDE is concerned.

I am willing to take on the work to document functions parameters, return types, etc. for the public API.

Is this something you would be happy to accept in to the projects?

michaelward82 commented 11 years ago

Please ignore, the docs are mostly there anyway!

treffynnon commented 11 years ago

Where the docs are lacking I would be happy to receive pull requests by the way. I had been slowly converting the comments as and when I changed the related methods etc. so some are definitely missing the correct doc blocks.