Changeset 42403 for trunk/src/wp-admin/js/code-editor.js

Timestamp:

12/15/2017 01:41:56 PM (8 years ago)

Author:

atimmer

Message:

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.

File:

• trunk/src/wp-admin/js/code-editor.js (modified) (5 diffs)

trunk/src/wp-admin/js/code-editor.js

@@ -1 +1 @@
 if ( 'undefined' === typeof window.wp ) {
+    /**
+     * @namespace wp
+     */
     window.wp = {};
 }
 if ( 'undefined' === typeof window.wp.codeEditor ) {
+    /**
+     * @namespace wp.codeEditor
+     */
     window.wp.codeEditor = {};
 }
@@ -34 +40 @@
      * @param {Function}   settings.onChangeLintingErrors - Callback for when there are changes to linting errors.
      * @param {Function}   settings.onUpdateErrorNotice - Callback to update error notice.
+     *
      * @returns {void}
      */
@@ -203 +210 @@
      * @param {Function}   settings.onTabNext - Callback to handle tabbing to the next tabbable element.
      * @param {Function}   settings.onTabPrevious - Callback to handle tabbing to the previous tabbable element.
+     *
      * @returns {void}
      */
@@ -241 +249 @@
 
     /**
-     * @typedef {object} CodeEditorInstance
+     * @typedef {object} wp.codeEditor~CodeEditorInstance
      * @property {object} settings - The code editor settings.
      * @property {CodeMirror} codemirror - The CodeMirror instance.
@@ -261 +269 @@
      * @param {object}                [settings.htmlhint] - Rules for HTMLHint.
      * @param {object}                [settings.jshint] - Rules for JSHint.
+     *
      * @returns {CodeEditorInstance} Instance.
      */