diff options
| author | Timo Tijhof <krinklemail@gmail.com> | 2020-04-19 21:07:33 +0100 |
|---|---|---|
| committer | Timo Tijhof <krinklemail@gmail.com> | 2020-04-19 21:10:53 +0100 |
| commit | 35d02383b9085dd4a802ee4c256497264e93608f (patch) | |
| tree | fca097d039994db059ebd81a916f86a3db1afa2a /maintenance/jsduck | |
| parent | f7141fa09fa62af5718efada678f0ce2d2a7591b (diff) | |
| download | mediawikicore-35d02383b9085dd4a802ee4c256497264e93608f.tar.gz mediawikicore-35d02383b9085dd4a802ee4c256497264e93608f.zip | |
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
Diffstat (limited to 'maintenance/jsduck')
| -rw-r--r-- | maintenance/jsduck/external.js | 4 |
1 files changed, 2 insertions, 2 deletions
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: <https://api.jquery.com/jQuery.ajax/> * @method ajax * @static - * @return {jqXHR} + * @return {jQuery.jqXHR} */ /** @@ -34,7 +34,7 @@ /** * Source: <https://api.jquery.com/Types/#jqXHR> * @class jQuery.jqXHR - * @alternateClassName jqXHR + * @mixins jQuery.Promise */ /** |