[wp-trac] [WordPress Trac] #42505: Docblock improvements for 5.0

[WordPress Trac]

#42505: Docblock improvements for 5.0
----------------------------+-------------------
 Reporter:  johnbillion     |       Owner:
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  5.0
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |     Focuses:  docs
----------------------------+-------------------

Comment (by SergeyBiryukov):

 @afercia in #42530:
 > * ...seems to me all the new functions introduced in [41630] miss a
 @since notation in their docblocks.
 > * Additional note about documentation standards: many multiline inline
 comments introduced in [41630] use a double asterisk, e.g.:
 > {{{
 > /**
 >  * If the selection is on a shortcode with Live View, TinyMCE creates a
 bogus markup,
 >  * which we have to account for.
 >  */
 > }}}
 > * Note: one more coding standard that isn't met across [41630]:
 [https://make.wordpress.org/core/handbook/best-practices/coding-
 standards/javascript/#declaring-variables-with-var Declaring Variables
 With var]
 >  * Each function should begin with a single comma-delimited var
 statement that declares any local variables necessary

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