WordPress.org

Make WordPress Core

#21149 closed enhancement (fixed)

Misspelled @return statement and wrong function signatures in PHPDocs wp-includes/formatting.php

Reported by: c3mdigital Owned by: markjaquith
Milestone: 3.5 Priority: normal
Severity: normal Version: 3.1
Component: Inline Docs Keywords: has-patch commit
Focuses: Cc:

Description


Attachments (3)

21149.patch (4.6 KB) - added by c3mdigital 22 months ago.
21149.2.patch (2.8 KB) - added by SergeyBiryukov 22 months ago.
21149.3.patch (5.2 KB) - added by SergeyBiryukov 22 months ago.

Download all attachments as: .zip

Change History (9)

c3mdigital22 months ago

comment:1 c3mdigital22 months ago

  • Cc chris@… added
  • Component changed from General to Inline Docs

SergeyBiryukov22 months ago

comment:2 follow-up: SergeyBiryukov22 months ago

  • Milestone changed from Awaiting Review to 3.5

Reviewed and adjusted the patch. Didn't include some changes because they don't seem valid to me.

comment:3 in reply to: ↑ 2 ; follow-up: c3mdigital22 months ago

Replying to SergeyBiryukov:

Reviewed and adjusted the patch. Didn't include some changes because they don't seem valid to me.

Thanks for reviewing the patch. One thing I wanted to point out was the @usedby tag. This is a virtual tag, it is created by @uses to cross-reference the used element. http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/DocBlockTags/parserUsedByTag.html

SergeyBiryukov22 months ago

comment:4 georgestephanis22 months ago

+1 to 21149.3.patch

comment:5 in reply to: ↑ 3 SergeyBiryukov22 months ago

  • Keywords commit added

Replying to c3mdigital:

This is a virtual tag, it is created by @uses to cross-reference the used element.

Thanks, got it. I didn't notice at first that wp_iso_descrambler() is actually used by wp-mail.php, not by wp_mail().

21149.3.patch also replaces other instances of @usedby.

comment:6 markjaquith22 months ago

  • Owner set to markjaquith
  • Resolution set to fixed
  • Status changed from new to closed

In [21241]:

Bunch of PHPDoc corrections and cleanups. props c3mdigital. props SergeyBiryukov. fixes #21149

Note: See TracTickets for help on using tickets.