jsdoc.js

   1 'use strict';
   2 module.exports = {
   3         opts: {
   4                 destination: 'docs/js',
   5                 package: 'resources/package.json',
   6                 pedantic: true,
   7                 readme: 'resources/README.md',
   8                 recurse: true,
   9                 template: 'node_modules/jsdoc-wmf-theme'
  10         },
  11         plugins: [
  12                 'plugins/markdown',
  13                 'plugins/summarize'
  14         ],
  15         source: {
  16                 include: [
  17                         'resources/src/mediawiki.page.ready',
  18                         'resources/src/mediawiki.Title',
  19                         'resources/src/mediawiki.cookie',
  20                         'resources/src/mediawiki.storage.js',
  21                         'resources/src/mediawiki.String.js',
  22                         'resources/src/jsdoc.types.js',
  23                         'resources/src/jquery',
  24                         'resources/src/jquery.spinner',
  25                         'resources/src/jquery.tablesorter',
  26                         'resources/src/jquery.lengthLimit.js',
  27                         'resources/src/mediawiki.api',
  28                         'resources/src/mediawiki.base',
  29                         'resources/src/mediawiki.experiments.js',
  30                         'resources/src/mediawiki.ForeignUpload.js',
  31                         'resources/src/mediawiki.notification',
  32                         'resources/src/mediawiki.page.preview.js',
  33                         'resources/src/mediawiki.Upload.js',
  34                         'resources/src/mediawiki.page.watch.ajax',
  35                         'resources/src/mediawiki.util',
  36                         'resources/src/startup',
  37                         'resources/src/mediawiki.feedback',
  38                         'resources/src/mediawiki.template.js',
  39                         'resources/src/mediawiki.template.mustache.js',
  40                         'resources/src/mediawiki.user.js',
  41                         'resources/src/mediawiki.Uri'
  42
  43                 ],
  44                 exclude: [
  45                         /* The following modules are temporarily disabled as we haven't
  46                          got round to reviewing them and incorporating them into the documentation page yet. */
  47                         'resources/src/codex',
  48                         'resources/src/mediawiki.page.image.pagination.js',
  49                         'resources/src/codex-search',
  50                         'resources/src/mediawiki.page.media.js',
  51                         'resources/src/mediawiki.ForeignApi',
  52                         'resources/src/mediawiki.pulsatingdot',
  53                         'resources/src/mediawiki.ForeignStructuredUpload.BookletLayout',
  54                         'resources/src/mediawiki.rcfilters',
  55                         'resources/src/mediawiki.router',
  56                         'resources/src/mediawiki.searchSuggest',
  57                         'resources/src/mediawiki.skinning',
  58                         'resources/src/mediawiki.Upload.BookletLayout',
  59                         'resources/src/mediawiki.special',
  60                         'resources/src/mediawiki.Upload.Dialog.js',
  61                         'resources/src/mediawiki.special.apisandbox',
  62                         'resources/src/mediawiki.special.block.js',
  63                         'resources/src/mediawiki.special.changecredentails.js',
  64                         'resources/src/mediawiki.action',
  65                         'resources/src/mediawiki.special.changeemail.js',
  66                         'resources/src/mediawiki.action.edit',
  67                         'resources/src/mediawiki.special.changeslist',
  68                         'resources/src/mediawiki.special.changeslist.legend.js',
  69                         'resources/src/mediawiki.apipretty',
  70                         'resources/src/mediawiki.special.changeslist.watchlistexpiry',
  71                         'resources/src/mediawiki.checkboxtoggle.js',
  72                         'resources/src/mediawiki.special.contributions.js',
  73                         'resources/src/mediawiki.special.createaccount',
  74                         'resources/src/mediawiki.cldr',
  75                         'resources/src/mediawiki.special.editrecovery',
  76                         'resources/src/mediawiki.confirmCloseWindow.js',
  77                         'resources/src/mediawiki.special.preferences.ooui',
  78                         'resources/src/mediawiki.special.search',
  79                         'resources/src/mediawiki.debug',
  80                         'resources/src/mediawiki.special.search.commonsInterwikiWidget.js',
  81                         'resources/src/mediawiki.deflate',
  82                         'resources/src/mediawiki.diff',
  83                         'resources/src/mediawiki.special.unwatchedPages',
  84                         'resources/src/mediawiki.editRecovery',
  85                         'resources/src/mediawiki.special.upload',
  86                         'resources/src/mediawiki.feedlink',
  87                         'resources/src/mediawiki.special.userrights.js',
  88                         'resources/src/mediawiki.filewarning',
  89                         'resources/src/resources/src/mediawiki.special.watchlist',
  90                         'resources/src/mediawiki.helplink',
  91                         'resources/src/mediawiki.tempUserBanner',
  92                         'resources/src/mediawiki.htmlform',
  93                         'resources/src/mediawiki.tempUserCreated',
  94                         'resources/src/mediawiki.htmlform.ooui',
  95                         'resources/src/mediawiki.toc',
  96                         'resources/src/mediawiki.inspect.js',
  97                         'resources/src/mediawiki.jqueryMsg',
  98                         'resources/src/mediawiki.language',
  99                         'resources/src/mediawiki.language.months',
 100                         'resources/src/mediawiki.language.names',
 101                         'resources/src/mediawiki.language.specialCharacters',
 102                         'resources/src/mediawiki.userSuggest.js',
 103                         'resources/src/mediawiki.libs.jpegmeta',
 104                         'resources/src/mediawiki.visibleTimeout',
 105                         'resources/src/mediawiki.libs.pluralruleparser',
 106                         'resources/src/mediawiki.watchstar.widgets',
 107                         'resources/src/mediawiki.messagePoster',
 108                         'resources/src/mediawiki.widgets',
 109                         'resources/src/mediawiki.misc-authed-curate',
 110                         'resources/src/mediawiki.widgets.datetime',
 111                         'resources/src/mediawiki.misc-authed-ooui',
 112                         'resources/src/mediawiki.widgets.visibleLengthLimit',
 113                         'resources/src/mediawiki.misc-authed-pref',
 114                         'resources/src/moment',
 115                         'resources/src/oojs-global.js',
 116                         'resources/src/mediawiki.notification.convertmessagebox.js',
 117                         'resources/src/ooui-local.js',
 118                         'resources/src/qunitjs',
 119                         'resources/src/mediawiki.page.gallery.js',
 120                         'resources/src/skip-web2017-polyfills.js',
 121                         'resources/src/mediawiki.page.gallery.slideshow.js',
 122                         'resources/src/vue'
 123                 ]
 124         },
 125         templates: {
 126                 cleverLinks: true,
 127                 default: {
 128                         useLongnameInNav: true
 129                 },
 130                 wmf: {
 131                         linkMap: {
 132                                 Array: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array',
 133                                 Blob: 'https://developer.mozilla.org/en-US/docs/Web/API/Blob',
 134                                 CSSStyleSheet: 'https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet',
 135                                 Event: 'https://developer.mozilla.org/en-US/docs/Web/API/Event',
 136                                 File: 'https://developer.mozilla.org/en-US/docs/Web/API/File',
 137                                 HTMLElement: 'https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement',
 138                                 HTMLInputElement: 'https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement',
 139                                 'JSON.parse': 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse',
 140                                 jQuery: 'https://api.jquery.com/jQuery/',
 141                                 'jQuery.fn': 'https://api.jquery.com/jQuery/',
 142                                 'jQuery.Event': 'https://api.jquery.com/Types/#Event',
 143                                 'jQuery.Promise': 'https://api.jquery.com/Types/#Promise',
 144                                 Node: 'https://developer.mozilla.org/en-US/docs/Web/API/Node',
 145                                 'OO.ui.ProcessDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/#!/api/OO.ui.ProcessDialog',
 146                                 Promise: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise',
 147                                 Set: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set',
 148                                 URLSearchParams: 'https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams'
 149                         }
 150                 }
 151         }
 152 };