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                 'jsdoc-plugin-allow-dots-in-modules',
  13                 'plugins/markdown',
  14                 'plugins/summarize'
  15         ],
  16         source: {
  17                 include: [
  18                         'resources/src/'
  19                 ],
  20                 exclude: [
  21                         /* The following modules are temporarily disabled as we haven't
  22                          got round to reviewing them and incorporating them into the documentation page yet. */
  23                         'resources/src/codex',
  24                         'resources/src/codex-search',
  25                         'resources/src/mediawiki.ForeignApi',
  26                         'resources/src/mediawiki.ForeignStructuredUpload.BookletLayout',
  27                         'resources/src/mediawiki.rcfilters',
  28                         'resources/src/mediawiki.router',
  29                         'resources/src/mediawiki.Upload.BookletLayout',
  30                         'resources/src/mediawiki.Upload.Dialog.js',
  31                         'resources/src/mediawiki.htmlform.ooui',
  32                         'resources/src/mediawiki.language.specialCharacters',
  33                         'resources/src/moment',
  34                         'resources/src/oojs-global.js',
  35                         'resources/src/mediawiki.notification.convertmessagebox.js',
  36                         'resources/src/ooui-local.js',
  37                         'resources/src/vue'
  38                 ]
  39         },
  40         templates: {
  41                 cleverLinks: true,
  42                 default: {
  43                         useLongnameInNav: true
  44                 },
  45                 wmf: {
  46                         linkMap: {
  47                                 Array: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array',
  48                                 Blob: 'https://developer.mozilla.org/en-US/docs/Web/API/Blob',
  49                                 CSSStyleSheet: 'https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet',
  50                                 Event: 'https://developer.mozilla.org/en-US/docs/Web/API/Event',
  51                                 File: 'https://developer.mozilla.org/en-US/docs/Web/API/File',
  52                                 HTMLElement: 'https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement',
  53                                 HTMLInputElement: 'https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement',
  54                                 'JSON.parse': 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse',
  55                                 jQuery: 'https://api.jquery.com/jQuery/',
  56                                 'jQuery.fn': 'https://api.jquery.com/jQuery/',
  57                                 'jQuery.Deferred': 'https://api.jquery.com/Types/#Deferred',
  58                                 'jQuery.Event': 'https://api.jquery.com/Types/#Event',
  59                                 'jQuery.Promise': 'https://api.jquery.com/Types/#Promise',
  60                                 Node: 'https://developer.mozilla.org/en-US/docs/Web/API/Node',
  61                                 'OO.ui.ButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonWidget.html',
  62                                 'OO.ui.CopyTextLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.CopyTextLayout.html',
  63                                 'OO.ui.DropdownInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.DropdownInputWidget.html',
  64                                 'OO.ui.InputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.InputWidget.html',
  65                                 'OO.ui.MenuOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuOptionWidget.html',
  66                                 'OO.ui.MenuTagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuTagMultiselectWidget.html',
  67                                 'OO.ui.MessageDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MessageDialog.html',
  68                                 'OO.ui.OptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OptionWidget.html',
  69                                 'OO.ui.ProcessDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ProcessDialog.html',
  70                                 'OO.ui.SearchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchWidget.html',
  71                                 'OO.ui.SearchInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchInputWidget.html',
  72                                 'OO.ui.TagItemWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagItemWidget.html',
  73                                 'OO.ui.TagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagMultiselectWidget.html',
  74                                 'OO.ui.TextInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TextInputWidget.html',
  75                                 'OO.ui.ToggleSwitchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToggleSwitchWidget.html',
  76                                 'OO.ui.Widget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.Widget.html',
  77                                 Promise: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise',
  78                                 Set: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set',
  79                                 URLSearchParams: 'https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams'
  80                         }
  81                 }
  82         }
  83 };