PHPDocs typos for 3.2

[duck_]

For typos and such...

[westi]

In [17925]:

Fix typos and inconsistencies in PHPdoc / function declarations. See #17414 props duck_

[westi]

In [17926]:

More phpdoc typo fixes. See #17414 props Utkarsh

[westi]

@Utkarsh: git formatted patches are not preferred because they require manually mangling to apply to svn checkouts.

I had to edit the patch and correct the headers to get it to apply - unless you know of an automated way :)

[dremeda]

Started going through each file. There are a lot of inconsistencies. Should we be capitalizing? some comments are and others aren't, this varies within individual files and across all files. I want to make sure I'm keeping the correct format wherever possible.

Edit: Also noticed some comments are still using "Blog", is this still standard use?

[dremeda]

Typo & format fixes - No standard :/

[nacin]

Wow, lots of changes. I'll have to go through those individually... Most look good, but a few general notes:

No changes to external libraries, please.

@todo is phpdoc: ​http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.todo.pkg.html.

[dremeda]

Thanks for that Nacin. I tried to standardize wherever possible, in some cases I probably referenced the incorrect format, as the case with @todo.

If there is a better way of doing this let me know, and any other pointers are appreciated. I want to help not make things worse :)

Note: I will be going through more of this later today, just add a new patch?

[mfields]

/wp-includes/taxonomy.php appears to have a few deviations from phpDoc. Function level Doc Blocks do not support the @package or @subpackage tags. It is my understanding that functions will inherit this information from the Page Level Doc Block. Likewise methods of classes inherit this information from class-level doc blocks. I believe that many of these tags can be removed. I'd be happy to submit a patch here if this is a good idea.

​http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.package.pkg.html

[mfields]

Removes @package and @subpackage from many function doc blocks. Adds these tags in a few places.

[westi]

I don't think we should spend time on reviewing huge PHPDoc patches this close to release.

I am going to close this as fixed and would ask that you open a new 3.3-early ticket and attach the meat of these two monster patches there but broken down into smaller chunks - e.g. a folder at a time so they are easier to review and commit.