Add jquery.arrowSteps to jsduck

It's probably a doomed module, but we may as well document it.

Change-Id: I5c28d1abc5364de839806ed21c2edc0d1d655f86

diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json
index 837c00c..cdaa45c 100644 (file)
--- a/maintenance/jsduck/config.json
+++ b/maintenance/jsduck/config.json
@@ -17,6 +17,7 @@
                "../../resources/mediawiki.page/mediawiki.page.watch.ajax.js",
                "../../resources/mediawiki.api",
                "../../resources/mediawiki.language",
+               "../../resources/jquery/jquery.arrowSteps.js",
                "../../resources/jquery/jquery.localize.js",
                "../../resources/jquery/jquery.spinner.js",
                "../../resources/oojs",

diff --git a/resources/jquery/jquery.arrowSteps.js b/resources/jquery/jquery.arrowSteps.js
index a1fd679..daa2fd7 100644 (file)
--- a/resources/jquery/jquery.arrowSteps.js
+++ b/resources/jquery/jquery.arrowSteps.js
@@ -1,4 +1,4 @@
-/**
+/*!
  * jQuery arrowSteps plugin
  * Copyright Neil Kandalgaonkar, 2010
  *
@@ -7,40 +7,32 @@
  * (see http://www.fsf.org/licensing/licenses/gpl.html).
  * Derivative works and later versions of the code must be free software
  * licensed under the same or a compatible license.
- *
- *
- * DESCRIPTION
- *
- * Show users their progress through a series of steps, via a row of items that fit
- * together like arrows. One item can be highlighted at a time.
- *
- *
- * SYNOPSIS
- *
- * <ul id="robin-hood-daffy">
- *   <li id="guard"><div>Guard!</div></li>
- *   <li id="turn"><div>Turn!</div></li>
- *   <li id="parry"><div>Parry!</div></li>
- *   <li id="dodge"><div>Dodge!</div></li>
- *   <li id="spin"><div>Spin!</div></li>
- *   <li id="ha"><div>Ha!</div></li>
- *   <li id="thrust"><div>Thrust!</div></li>
- * </ul>
- *
- * <script>
- *   $( '#robin-hood-daffy' ).arrowSteps();
- *
- *   $( '#robin-hood-daffy' ).arrowStepsHighlight( '#guard' );
- *   // 'Guard!' is highlighted.
- *
- *   // ... user completes the 'guard' step ...
- *
- *   $( '#robin-hood-daffy' ).arrowStepsHighlight( '#turn' );
- *   // 'Turn!' is highlighted.
- * </script>
- *
+ */
+
+/**
+ * @class jQuery.plugin.arrowSteps
  */
 ( function ( $ ) {
+       /**
+        * Show users their progress through a series of steps, via a row of items that fit
+        * together like arrows. One item can be highlighted at a time.
+        *
+        *     <ul id="robin-hood-daffy">
+        *       <li id="guard"><div>Guard!</div></li>
+        *       <li id="turn"><div>Turn!</div></li>
+        *       <li id="parry"><div>Parry!</div></li>
+        *       <li id="dodge"><div>Dodge!</div></li>
+        *       <li id="spin"><div>Spin!</div></li>
+        *       <li id="ha"><div>Ha!</div></li>
+        *       <li id="thrust"><div>Thrust!</div></li>
+        *     </ul>
+        *
+        *     <script>
+        *       $( '#robin-hood-daffy' ).arrowSteps();
+        *     </script>
+        *
+        * @chainable
+        */
        $.fn.arrowSteps = function () {
                var $steps, width, arrowWidth,
                        paddingSide = $( 'body' ).hasClass( 'rtl' ) ? 'padding-left' : 'padding-right';
@@ -62,6 +54,19 @@
                return this;
        };
 
+       /**
+        * Highlights the element selected by the selector.
+        *
+        *       $( '#robin-hood-daffy' ).arrowStepsHighlight( '#guard' );
+        *       // 'Guard!' is highlighted.
+        *
+        *       // ... user completes the 'guard' step ...
+        *
+        *       $( '#robin-hood-daffy' ).arrowStepsHighlight( '#turn' );
+        *       // 'Turn!' is highlighted.
+        *
+        * @param {string} selector
+        */
        $.fn.arrowStepsHighlight = function ( selector ) {
                var $previous,
                        $steps = this.data( 'arrowSteps' );
@@ -79,4 +84,8 @@
                } );
        };
 
+       /**
+        * @class jQuery
+        * @mixins jQuery.plugin.arrowSteps
+        */
 }( jQuery ) );