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

WordPress Trac noreply at wordpress.org
Fri Sep 8 18:41:23 UTC 2017


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

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [changeset:"41351"]:
 {{{
 #!CommitTicketReference repository="" revision="41351"
 Docs: JSDoc improvements for namespaces.

 Improve JS parsing of our inline JSDocs by introducing `@namespace`,
 `@lends` and `@memberOf`. Helps set the way for showing our JavaScript
 documentation on developer.wordpress.org, see
 https://meta.trac.wordpress.org/ticket/3063.

 * Define all used namespaces using @namespace.
 * Correctly specify in which namespace each class is using @memberOf.
 * Define each usage of the extend function as a prototype assignment using
 @lends.
 * Some comment blocks were moved to correct the parsing of certain
 definitions.

 Props herregroen, atimmer, netweb, SergeyBiryukov.
 Fixes #41682.
 }}}

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


More information about the wp-trac mailing list