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

[WordPress Trac]

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

 * owner:   => atimmer
 * status:  new => closed
 * resolution:   => fixed


Comment:

 In [changeset:"42403"]:
 {{{
 #!CommitTicketReference repository="" revision="42403"
 Docs: Improve wp-admin JSDoc structural data globally.

 JSDoc takes it structural data from `@namespace`, `@lends` and
 `@memberOf`. This change fixes these tags for all JavaScript files in the
 wp-admin folder.

 * Add jsdoc configuration to parse wp-admin/js files. Use `jsdoc -c
 jsdoc.conf.json` to generate JSDoc.
 * Define all used namespaces using `@namespace`.
 * Define each usage of the extend function as a prototype assignment using
 `@lends`.
 * Add `@alias` if JSDoc cannot detect the correct name automatically.

 This has previously been corrected for all `wp-includes` JavaScript files:
 [41351].

 Props herregroen.
 Fixes #42485.
 }}}

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