[wp-trac] [WordPress Trac] #32246: Fix a variety of phpDoc issues

[WordPress Trac]

#32246: Fix a variety of phpDoc issues
----------------------------+-----------------------------
 Reporter:  DrewAPicture    |       Owner:  DrewAPicture
     Type:  task (blessed)  |      Status:  assigned
 Priority:  low             |   Milestone:  Future Release
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  has-patch       |     Focuses:  docs
----------------------------+-----------------------------

Comment (by nextendweb):

 37550:

 @DrewAPicture I'm not sure that the modified documentation describes the
 structure of that action.
 Here is an example action with type => plugin:

 {{{#!php
 <?php
                 do_action( 'upgrader_process_complete', $this, array(
                         'action' => 'update',
                         'type' => 'plugin',
                         'bulk' => true,
                         'plugins' => $plugins,
                 ) );
 }}}


 In your modified documentation it looks like:

 {{{
 @type string $plugin
 }}}

 but it should be :

 {{{
 @type array $plugins {
   Array of bulk item update data.
 ...
 ...
 ..
 }
 }}}

 Same applies for other types, as all of them placed under a different
 array key.

--
Ticket URL: <https://core.trac.wordpress.org/ticket/32246#comment:339>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform