From 937ac6e34357357cd5ff92dfdf9fb8822dc6c0fd Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Sun, 27 Apr 2014 17:23:30 +0200 Subject: [PATCH] jquery.tabIndex: Add jsduck documentation Change-Id: I73ec9b6e8a5fcc95ea71dcaa19f9b9aa481fde18 --- maintenance/jsduck/config.json | 1 + resources/src/jquery/jquery.tabIndex.js | 15 ++++++++++----- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/maintenance/jsduck/config.json b/maintenance/jsduck/config.json index fb8166bf05..d4d78f9ca1 100644 --- a/maintenance/jsduck/config.json +++ b/maintenance/jsduck/config.json @@ -30,6 +30,7 @@ "../../resources/src/jquery/jquery.localize.js", "../../resources/src/jquery/jquery.makeCollapsible.js", "../../resources/src/jquery/jquery.spinner.js", + "../../resources/src/jquery/jquery.tabIndex.js", "../../resources/lib/oojs", "../../resources/lib/oojs-ui" ] diff --git a/resources/src/jquery/jquery.tabIndex.js b/resources/src/jquery/jquery.tabIndex.js index cdae0badc9..46cc8f2cb9 100644 --- a/resources/src/jquery/jquery.tabIndex.js +++ b/resources/src/jquery/jquery.tabIndex.js @@ -1,12 +1,12 @@ /** - * jQuery tabIndex + * @class jQuery.plugin.tabIndex */ ( function ( $ ) { /** - * Finds the lowerst tabindex in use within a selection + * Find the lowest tabindex in use within a selection. * - * @return number Lowest tabindex on the page + * @return {number} Lowest tabindex on the page */ $.fn.firstTabIndex = function () { var minTabIndex = null; @@ -29,9 +29,9 @@ }; /** - * Finds the highest tabindex in use within a selection + * Find the highest tabindex in use within a selection. * - * @return number Highest tabindex on the page + * @return {number} Highest tabindex on the page */ $.fn.lastTabIndex = function () { var maxTabIndex = null; @@ -49,4 +49,9 @@ return maxTabIndex; }; + /** + * @class jQuery + * @mixins jQuery.plugin.tabIndex + */ + }( jQuery ) ); -- 2.20.1