Opened 16 months ago
Closed 11 months ago
#59651 closed task (blessed) (fixed)
Docblock improvements for 6.5
Reported by: |
|
Owned by: | |
---|---|---|---|
Milestone: | 6.5 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs, coding-standards | Cc: |
Change History (34)
This ticket was mentioned in PR #5507 on WordPress/wordpress-develop by @kebbet.
16 months ago
#1
- Keywords has-patch added
This ticket was mentioned in PR #5585 on WordPress/wordpress-develop by @jrf.
16 months ago
#2
- Keywords has-unit-tests added
### Docs: fix incorrect @private tags
The @private
tag doesn't exist and isn't supported. To indicate something is private
when in the global namespace, @access private
should be used instead.
### Docs: use proper case for @todo tags
The correct tag is @todo
, not @TODO
or @todo:
(not the trailing colon).
### Docs: fix various incorrect WP-flavoured array specifications
Tags like @string
or @array
do not exist and are not supported. The way these were used here, also meant duplicate information being documented.
Fixed now by using the @type
tag as per the WP flavour of array documentation.
Includes some fixes to the documentation formatting.
### Docs: fix incorrect @return tag
@return[]
is not a valid tag. Fixed now.
As this is a test, I've not bothered with the WP flavoured array annotation and just used the industry standard one.
### Docs: fix broken @covers tag
Without the space between the tag and the "description", the tag will not be recognized and the test will not record coverage correctly.
### Docs: fix incorrect property doc
The @array
tag does not exist. This should be @var array
.
### Docs: miscellaneous other doc fixes
@contrib
is not a valid tag.@origin
is not a valid tag.@ref
is not a valid tag.@blessed
is not a valid tag and doesn't convey any meaningful information.@issue
is not a valid tag.
Trac ticket: https://core.trac.wordpress.org/ticket/59651
#3
@
16 months ago
- Keywords has-unit-tests removed
I've just opened GitHub PR #5585 with 7 small doc tag related patches.
Issues discovered while testing a sniff I'm writing.
@SergeyBiryukov commented on PR #5585:
15 months ago
#12
#14
in reply to:
↑ 6
@
15 months ago
Replying to SergeyBiryukov:
In 57077:
@SergeyBiryukov do you have the corresponding update for Gutenberg already for this change?
@SergeyBiryukov commented on PR #5507:
15 months ago
#16
Thanks for the PR! Merged in r57120.
This ticket was mentioned in PR #5823 on WordPress/wordpress-develop by @mukesh27.
14 months ago
#19
Trac ticket: https://core.trac.wordpress.org/ticket/59651
This ticket was mentioned in PR #6213 on WordPress/wordpress-develop by @huzaifaalmesbah.
11 months ago
#32
Trac ticket: https://core.trac.wordpress.org/ticket/59651
### Proper case for @todo
tags
Valid: @todo
Fixing minor style issues in the comments, after
6.3.2
.changed to https://core.trac.wordpress.org/ticket/59651