Opened 11 years ago
Closed 10 years ago
#28408 closed defect (bug) (fixed)
Improve phpdocs for wp-includes/media.php
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | 4.2 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Media | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description (last modified by )
Bring docs in wp-admin/includes/media.php up to Core Docs Syntax standards.
Somewhat related to #27882
Attachments (2)
Change History (9)
#3
@
11 years ago
- Description modified (diff)
- Milestone changed from 4.0 to Future Release
- Owner set to DrewAPicture
- Status changed from new to assigned
@
10 years ago
Clean up DocBlock formatting, add some missing arguments, global declarations, and @since tags.
#4
@
10 years ago
- Keywords needs-patch added
Hi Steve, thanks for the patch. Here are some general notes on 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
#5
@
10 years ago
- Keywords has-patch added; needs-patch removed
- Milestone changed from Future Release to 4.2
- Status changed from assigned to reviewing
Note: See
TracTickets for help on using
tickets.
In 28632: