Request to adopt better documentation standards

[pfrenssen]

I really love this project and I am eager to contribute to it but the lack of documentation discourages me. I find that undocumented methods and arguments slow me down. To understand what is going on I'm forced to read the code, instead of just scanning the documentation. And this not only affects me, also my IDE needs documentation in order to function properly. It doesn't know argument and return types if they are not documented.

Am I alone with this feeling? I see this pattern in many PHP projects, and I see people advocating "self-documenting code".

Maybe I'm spoiled because Drupal core has such outstanding documentation, and this makes me rely on things like autocompletion in PHPStorm more than it probably should?

I would like to open this discussion to see what other people think.

[jmolivas]

@pfrenssen: Totally agree on this adding the missing dockblocks with parameters and returning types must be mandatory on each method.

Also, I am working on implement some PHPQA tools on the project to help us reporting the missing pieces so we can focus on have them fixed.

[itsdarrylnorris]

@pfrenssen , @jmolivas I will open few issues to target some docblocks to make sure we documented them right.