Changeset 41351 for trunk/package.json

Timestamp:

09/08/2017 06:41:20 PM (7 years ago)

Author:

adamsilverstein

Message:

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.

File:

• trunk/package.json (modified) (2 diffs)

trunk/package.json

@@ -28 +28 @@
     "grunt-contrib-watch": "~1.0.0",
     "grunt-includes": "~0.5.1",
+    "grunt-jsdoc": "^2.1.0",
     "grunt-jsvalidate": "~0.2.2",
     "grunt-legacy-util": "^0.2.0",
@@ -35 +36 @@
     "grunt-rtlcss": "~2.0.1",
     "grunt-sass": "~1.2.1",
+    "ink-docstrap": "^1.3.0",
     "matchdep": "~1.0.0"
   }