[wp-trac] [WordPress Trac] #28408: Improve phpdocs for wp-admin/includes/media.php

[WordPress Trac]

#28408: Improve phpdocs for wp-admin/includes/media.php
--------------------------+-----------------------------
 Reporter:  DrewAPicture  |       Owner:  DrewAPicture
     Type:  defect (bug)  |      Status:  assigned
 Priority:  normal        |   Milestone:  Future Release
Component:  Media         |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  needs-patch   |     Focuses:  docs
--------------------------+-----------------------------
Changes (by DrewAPicture):

 * keywords:   => needs-patch


Comment:

 Hi Steve, thanks for the patch. Here are some general notes on
 [attachment:28408.patch]:

 * There should be a blank line between the `@since` tag block (one or
 more) and any other tags, such as `@see`. Also, `@since` is always first.
 * We have a very specific syntax for marking parameters as optional (the
 code reference expects it):
 {{{
 @param type $var Optional. Description. Accepts. Default.
 }}}
 * There are several parameters you've fixed descriptions for that are also
 optional so they should be marked as such, see above for that syntax

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