From 35d02383b9085dd4a802ee4c256497264e93608f Mon Sep 17 00:00:00 2001 From: Timo Tijhof Date: Sun, 19 Apr 2020 21:07:33 +0100 Subject: docs: Remove use of 'jqXHR' and 'mediaWiki' jsduck aliases The `@alternateClassName` feature does not map cleanly to JSDoc, so reduce its use to make the migration smoother. Also, it was my intention to only use `@alternateClassName` as a way to overcome limitations in JSDuck and/or as a stop-gap to document hacky or overly clever code, not as a general way to just randomly have two names for the same thing within docs. * jqXHR: Just use jQuery.jqXHR instead. Also add missing inheritence to Promise. * mediaWiki: Just use mw instead. It's already discouraged in real code, we really don't need to allow it within doc typehints. Bug: T138401 Change-Id: I915f747e440bad8f9bb2c11f35abc32ebdb69247 --- maintenance/jsduck/external.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'maintenance/jsduck') diff --git a/maintenance/jsduck/external.js b/maintenance/jsduck/external.js index 29d6affab0e2..fa89d4a03a18 100644 --- a/maintenance/jsduck/external.js +++ b/maintenance/jsduck/external.js @@ -7,7 +7,7 @@ * Source: * @method ajax * @static - * @return {jqXHR} + * @return {jQuery.jqXHR} */ /** @@ -34,7 +34,7 @@ /** * Source: * @class jQuery.jqXHR - * @alternateClassName jqXHR + * @mixins jQuery.Promise */ /** -- cgit v1.2.3