[wp-trac] [WordPress Trac] #27098: Twenty Fourteen: Ditch all uses of `@return void`.

WordPress Trac noreply at wordpress.org
Tue Feb 11 21:07:18 UTC 2014


#27098: Twenty Fourteen: Ditch all uses of `@return void`.
-------------------------------+------------------------------
 Reporter:  philiparthurmoore  |       Owner:
     Type:  defect (bug)       |      Status:  new
 Priority:  normal             |   Milestone:  Awaiting Review
Component:  Bundled Theme      |     Version:  trunk
 Severity:  normal             |  Resolution:
 Keywords:                     |     Focuses:  docs
-------------------------------+------------------------------

Comment (by obenland):

 In [http://www.phpdoc.org/docs/latest/for-users/phpdoc/tags/return.html
 phpDocumentor]:

 > It is RECOMMENDED when documenting to use this tag with every function
 and method. Exceptions to this recommendation are […] functions and
 methods without a `return` value, the @return tag MAY be omitted here, in
 which case @return void is implied.

 So we're just being explicit here.

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


More information about the wp-trac mailing list