[wp-trac] [WordPress Trac] #41682: JSDoc correction for namespaces

[WordPress Trac]

#41682: JSDoc correction for namespaces
--------------------------+-------------------------------
 Reporter:  herregroen    |       Owner:  adamsilverstein
     Type:  defect (bug)  |      Status:  assigned
 Priority:  normal        |   Milestone:  4.9
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  javascript, docs
--------------------------+-------------------------------

Comment (by herregroen):

 Replying to [comment:14 SergeyBiryukov]:
 > Replying to [comment:13 herregroen]:
 > > The comments I've removed were either incorrectly used `@global` tags
 ( these do not document a global being used, they document that the
 function/variable being documented is a global and thus override
 `@memberOf` statements ) or comments I felt added no additional
 information when the correct tags were added
 >
 > I've noticed the patch removes one of the comments added in [33709] for
 `customize-loader.js`:
 > {{{
 > /*
 >  * Expose a public API that allows the customizer to be
 >  * loaded on any page.
 >  */
 > }}}
 > But keeps a similar comment in `customize-preview.js`:
 > {{{
 > /*
 >  * Script run inside a Customizer preview frame.
 >  */
 > }}}
 > Is there a reason for removing the first comment?

 In the places I've added `@namespace` tags where there were existing
 comments mentioning exposing the variable, declaring a namespace or
 anything to that extent I've removed those comments as I personally felt
 the `@namespace` tag conveys this information already.

 If people feel these comments still add value then I will add them back
 in.

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