[wp-trac] [WordPress Trac] #44422: Missing @return tag and wrong parameter reference in function/method PHPDoc comment

WordPress Trac noreply at wordpress.org
Thu Jun 21 11:35:13 UTC 2018


#44422: Missing @return tag and wrong parameter reference in function/method PHPDoc
comment
------------------------------------+-----------------------------
 Reporter:  subrataemfluence        |      Owner:  (none)
     Type:  defect (bug)            |     Status:  new
 Priority:  normal                  |  Milestone:  Awaiting Review
Component:  Filesystem API          |    Version:  trunk
 Severity:  normal                  |   Keywords:  needs-patch
  Focuses:  docs, coding-standards  |
------------------------------------+-----------------------------
 File name: `src/wp-includes/pomo/streams.php`

 Wrong parameter name reference

 {{{#!php
 <?php
 /**
 * ...
 * @param integer count How many elements should be read
 * ...
 */
 function readint32array( $count ) {
  ...
 }
 }}}


 Missing `@return` tag.

 {{{#!php
 <?php
 /**
 * @param int $bytes
 */
 function read( $bytes ) {
    return fread( $this->_f, $bytes );
 }
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/44422>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list