Changeset 41351 for trunk/src/wp-includes/js/media/views/embed/link.js

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/src/wp-includes/js/media/views/embed/link.js (modified) (2 diffs)

trunk/src/wp-includes/js/media/views/embed/link.js

@@ +1 @@
+var $ = jQuery,
+    EmbedLink;
+
 /**
  * wp.media.view.EmbedLink
+ *
+ * @memberOf wp.media.view
  *
  * @class
@@ -8 +13 @@
  * @augments Backbone.View
  */
-var $ = jQuery,
-    EmbedLink;
-
-EmbedLink = wp.media.view.Settings.extend({
+EmbedLink = wp.media.view.Settings.extend(/** @lends wp.media.view.EmbedLink.prototype */{
     className: 'embed-link-settings',
     template:  wp.template('embed-link-settings'),