Add jquery.autoEllipsis to jsduck

Change-Id: I2c1c1eb3e0f92a78e50f8fe89f47d10e3a732325

diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json
index 2059148..c9736df 100644 (file)
--- a/maintenance/jsduck/config.json
+++ b/maintenance/jsduck/config.json
@@ -18,6 +18,7 @@
                "../../resources/mediawiki.api",
                "../../resources/mediawiki.language",
                "../../resources/jquery/jquery.arrowSteps.js",
+               "../../resources/jquery/jquery.autoEllipsis.js",
                "../../resources/jquery/jquery.badge.js",
                "../../resources/jquery/jquery.byteLimit.js",
                "../../resources/jquery/jquery.localize.js",

diff --git a/resources/jquery/jquery.arrowSteps.js b/resources/jquery/jquery.arrowSteps.js
index daa2fd7..c44e7c5 100644 (file)
--- a/resources/jquery/jquery.arrowSteps.js
+++ b/resources/jquery/jquery.arrowSteps.js
@@ -31,6 +31,7 @@
         *       $( '#robin-hood-daffy' ).arrowSteps();
         *     </script>
         *
+        * @return {jQuery}
         * @chainable
         */
        $.fn.arrowSteps = function () {

diff --git a/resources/jquery/jquery.autoEllipsis.js b/resources/jquery/jquery.autoEllipsis.js
index a473f61..57d8f94 100644 (file)
--- a/resources/jquery/jquery.autoEllipsis.js
+++ b/resources/jquery/jquery.autoEllipsis.js
@@ -1,6 +1,5 @@
 /**
- * Plugin that automatically truncates the plain text contents of an element
- * and adds an ellipsis.
+ * @class jQuery.plugin.autoEllipsis
  */
 ( function ( $ ) {
 
@@ -11,6 +10,21 @@ var
        // Use a separate cache when match highlighting is enabled
        matchTextCache = {};
 
+/**
+ * Automatically truncate the plain text contents of an element and add an ellipsis
+ *
+ * @param {Object} options
+ * @param {'center'|'left'|'right'} [options.position='center'] Where to remove text.
+ * @param {boolean} [options.tooltip=false] Whether to show a tooltip with the remainder
+ * of the text.
+ * @param {boolean} [options.restoreText=false] Whether to save the text for restoring
+ * later.
+ * @param {boolean} [options.hasSpan=false] Whether the element is already a container,
+ * or if the library should create a new container for it.
+ * @param {string|null} [options.matchText=null] Text to highlight, e.g. search terms.
+ * @return {jQuery}
+ * @chainable
+ */
 $.fn.autoEllipsis = function ( options ) {
        options = $.extend( {
                position: 'center',
@@ -146,4 +160,9 @@ $.fn.autoEllipsis = function ( options ) {
        } );
 };
 
+/**
+ * @class jQuery
+ * @mixins jQuery.plugin.autoEllipsis
+ */
+
 }( jQuery ) );

diff --git a/resources/jquery/jquery.localize.js b/resources/jquery/jquery.localize.js
index 8c8fb56..f499e10 100644 (file)
--- a/resources/jquery/jquery.localize.js
+++ b/resources/jquery/jquery.localize.js
@@ -99,12 +99,12 @@ function msg( options, key ) {
  * Appends something like this to the body...
  *     <p>You may not get there all in one piece.</p>
  *
- * @method
  * @param {Object} options Map of options to be used while localizing
  * @param {string} options.prefix String to prepend to all message keys
  * @param {Object} options.keys Message key aliases, used for remapping keys to a template
  * @param {Object} options.params Lists of parameters to use with certain message keys
  * @return {jQuery}
+ * @chainable
  */
 $.fn.localize = function ( options ) {
        var $target = this,

diff --git a/resources/mediawiki/mediawiki.htmlform.js b/resources/mediawiki/mediawiki.htmlform.js
index 0284e68..5ba1a54 100644 (file)
--- a/resources/mediawiki/mediawiki.htmlform.js
+++ b/resources/mediawiki/mediawiki.htmlform.js
@@ -10,6 +10,7 @@
         *
         * @param {boolean} [instantToggle=false]
         * @return {jQuery}
+        * @chainable
         */
        $.fn.goIn = function ( instantToggle ) {
                if ( instantToggle === true ) {
@@ -23,6 +24,7 @@
         *
         * @param {boolean} [instantToggle=false]
         * @return jQuery
+        * @chainable
         */
        $.fn.goOut = function ( instantToggle ) {
                if ( instantToggle === true ) {