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

[WordPress Trac]

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

 * status:  closed => reopened
 * resolution:  invalid =>
 * milestone:   => Awaiting Review


Comment:

 Re-opening for more discussion.

 The core [http://make.wordpress.org/core/handbook/inline-documentation-
 standards/php-documentation-standards/ inline docs standard] -- which is
 our first-and-foremost reference here, doesn't recommend using `@return
 void` **anywhere outside of the bundled themes**.

 When we developed the standard last fall, the decision was made to ignore
 the use of `@return void` in the bundled themes, as they had been
 utilizing that style since Twenty Ten. The `@return void` tags aren't used
 in any consistency anywhere else in Core.

 I think there's a good argument in favor of removing them altogether from
 the bundled themes -- this would bring that code in-line with the core
 standard.

 Side note: It's important to remember that while the core inline
 documentation standard is largely based on and inspired by the
 phpDocumenter spec, it doesn't adhere to it 100 percent. Our standard is
 largely based on existing practices -- regardless of whether they might be
 considered "good" or "bad".

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