Changeset 30127

Timestamp:

10/31/2014 11:54:50 PM (12 years ago)

Author:

wonderboymusic

Message:

Add some JSDoc blocks to revisions.js.

Props ericlewis.
See #30222.

File:

• trunk/src/wp-admin/js/revisions.js (modified) (6 diffs)

trunk/src/wp-admin/js/revisions.js

@@ -1 +1 @@
 /* global _wpRevisionsSettings, isRtl */
+/**
+ * @file Revisions interface functions, Backbone classes and
+ * the revisions.php document.ready bootstrap.
+ *
+ */
+
 window.wp = window.wp || {};
 
 (function($) {
     var revisions;
-
+    /**
+     * Expose the module in window.wp.revisions.
+     */
     revisions = wp.revisions = { model: {}, view: {}, controller: {} };
 
@@ -13 +21 @@
     revisions.debug = false;
 
+    /**
+     * wp.revisions.log
+     *
+     * A debugging utility for revisions. Works only when a
+     * debug flag is on and the browser supports it.
+     */
     revisions.log = function() {
         if ( window.console && revisions.debug ) {
@@ -180 +194 @@
     revisions.model.Revision = Backbone.Model.extend({});
 
+    /**
+     * wp.revisions.model.Revisions
+     *
+     * A collection of post revisions.
+     */
     revisions.model.Revisions = Backbone.Collection.extend({
         model: revisions.model.Revision,
@@ -353 +372 @@
 
 
+    /**
+     * wp.revisions.model.FrameState
+     *
+     * The frame state.
+     *
+     * @see wp.revisions.view.Frame
+     *
+     * @param {object}                    attributes        Model attributes - none are required.
+     * @param {object}                    options           Options for the model.
+     * @param {revisions.model.Revisions} options.revisions A collection of revisions.
+     */
     revisions.model.FrameState = Backbone.Model.extend({
         defaults: {
@@ -500 +530 @@
      */
 
-    // The frame view. This contains the entire page.
+    /**
+     * wp.revisions.view.Frame
+     *
+     * Top level frame that orchestrates the revisions experience.
+     *
+     * @param {object}                     options       The options hash for the view.
+     * @param {revisions.model.FrameState} options.model The frame state model.
+     */
     revisions.view.Frame = wp.Backbone.View.extend({
         className: 'revisions',
@@ -547 +584 @@
     });
 
-    // The control view.
-    // This contains the revision slider, previous/next buttons, the meta info and the compare checkbox.
+    /**
+     * wp.revisions.view.Controls
+     *
+     * The controls view.
+     *
+     * Contains the revision slider, previous/next buttons, the meta info and the compare checkbox.
+     */
     revisions.view.Controls = wp.Backbone.View.extend({
         className: 'revisions-controls',