WordPress.org

Make WordPress Core

Opened 3 years ago

Closed 3 years ago

Last modified 2 years ago

#42485 closed defect (bug) (fixed)

JSDoc correction for admin namespaces

Reported by: herregroen Owned by: atimmer
Milestone: 5.1 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch
Focuses: javascript, docs Cc:

Description

See #41682 for context.

This fixes the same issues for all javascript files in the wp-admin directory.

Attachments (4)

jsdoc-admin-namespaces.patch​ (90.9 KB) - added by herregroen 3 years ago.
jsdoc-admin-namespaces.2.patch​ (90.9 KB) - added by atimmer 3 years ago.
jsdoc-admin-namespaces.3.patch​ (86.2 KB) - added by herregroen 3 years ago.
jsdoc-admin-namespaces.4.patch​ (86.4 KB) - added by atimmer 3 years ago.

Download all attachments as: .zip

Change History (12)

@herregroen
3 years ago

#2 @ocean90
3 years ago

  • Keywords has-patch added
  • Milestone changed from Awaiting Review to 5.0
  • Version trunk deleted

This ticket was mentioned in ​Slack in #core-js by herregroen. ​View the logs.
3 years ago

This ticket was mentioned in ​Slack in #core-js by herregroen. ​View the logs.
3 years ago

@atimmer
3 years ago

#5 @atimmer
3 years ago

jsdoc-admin-namespaces.2.patch is a refreshed patch. Created by merging master into the branch using git on the pull request: ​https://github.com/Yoast/wordpress-develop-mirror/pull/84/files.

@herregroen
3 years ago

@atimmer
3 years ago

#6 @atimmer
3 years ago

  • Owner set to atimmer
  • Resolution set to fixed
  • Status changed from new to closed

In 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.

This ticket was mentioned in ​Slack in #core-js by atimmer. ​View the logs.
3 years ago

#8 @johnbillion
2 years ago

  • Milestone changed from 5.0 to 5.1
Note: See TracTickets for help on using tickets.