Doc Block Datatypes

[GoogleCodeExporter]

Mark this one as low priority. Hope I'm not bugging you too much, I just like 
to help open source projects that I use, return the favor. :)

I use a IDE product called phpStorm, which has deep code insight. As I develop 
custom modules, the IDE reports many errors of wrong data types. Same happens 
when I look at SimpleSAMLphp files. The issue is missing datatypes in the doc 
block @param lines. Would you care if I go through and fix these with a patch? 
It would be helpful so I don't have to fix them when upgrading SimpleSAMLphp. 
Just want to check before putting the effort into such a big task. Thanks

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.p
aram.pkg.html

Original issue reported on code.google.com by pan...@traileyes.com on 23 Nov 2011 at 4:46

[GoogleCodeExporter]

Is it complaining because there is missing phpdoc-comments for functions or 
because they are incorrect (missing @param-lines, incorrect @param-lines, etc.)?

Incorrect phpdoc-comments should certainly be fixed, and patches for that would 
certainly be welcome.

Whether you want to add phpdoc-comments where they are missing is up to you - I 
would almost certainly accept such a patch, but I don't think I will force 
people to always add phpdoc-comments to functions, which means that new 
warnings will appear (if phpStorm gives warnings when it doesn't have any 
information about the parameters).

Original comment by olavmrk@gmail.com on 2 Dec 2011 at 10:54

[GoogleCodeExporter]

Mainly what I've seen is that the @param's and @return's have a description but 
don't define a data type first. Then it thinks the first word in the 
description is the data type, like "The". Missing phpdoc-comments don't appear 
to be an issue, phpStorm has code intelligence and can figure it out.

When I get some time, I'll download a fresh copy, fix any issues and attach a 
patch here. Thanks

Original comment by pan...@traileyes.com on 2 Dec 2011 at 3:35