jsdoc.js 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. 'use strict';
  2. module.exports = {
  3. opts: {
  4. destination: 'docs/js',
  5. package: 'resources/package.json',
  6. pages: {
  7. modules: {
  8. longname: 'Modules',
  9. readme: 'resources/src/modules.md'
  10. },
  11. namespaces: {
  12. depth: 1,
  13. longname: 'Globals',
  14. readme: 'resources/src/README.md'
  15. }
  16. },
  17. pedantic: true,
  18. readme: 'resources/README.md',
  19. recurse: true,
  20. template: 'node_modules/jsdoc-wmf-theme'
  21. },
  22. plugins: [
  23. 'node_modules/jsdoc-wmf-theme/plugins/allow-dots-in-modules',
  24. 'plugins/markdown',
  25. 'node_modules/jsdoc-wmf-theme/plugins/summarize',
  26. 'node_modules/jsdoc-wmf-theme/plugins/betterlinks'
  27. ],
  28. source: {
  29. include: [
  30. 'resources/src/'
  31. ]
  32. },
  33. templates: {
  34. cleverLinks: true,
  35. default: {
  36. useLongnameInNav: true
  37. },
  38. wmf: {
  39. siteMap: {
  40. sections: true
  41. },
  42. hideSections: [ 'Classes', 'Events' ],
  43. repository: 'https://gerrit.wikimedia.org/g/mediawiki/core/',
  44. linkMap: {
  45. Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array',
  46. Blob: 'https://developer.mozilla.org/docs/Web/API/Blob',
  47. boolean: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean',
  48. CSSStyleSheet: 'https://developer.mozilla.org/docs/Web/API/CSSStyleSheet',
  49. Date: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date',
  50. Event: 'https://developer.mozilla.org/docs/Web/API/Event',
  51. File: 'https://developer.mozilla.org/docs/Web/API/File',
  52. Function: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function',
  53. HTMLElement: 'https://developer.mozilla.org/docs/Web/API/HTMLElement',
  54. HTMLInputElement: 'https://developer.mozilla.org/docs/Web/API/HTMLInputElement',
  55. HTMLStyleElement: 'https://developer.mozilla.org/docs/Web/API/HTMLStyleElement',
  56. 'JSON.parse': 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse',
  57. jQuery: 'https://api.jquery.com/jQuery/',
  58. 'jQuery.fn': 'https://api.jquery.com/jQuery/',
  59. 'jQuery.Deferred': 'https://api.jquery.com/Types/#Deferred',
  60. 'jQuery.Event': 'https://api.jquery.com/Types/#Event',
  61. 'jQuery.Promise': 'https://api.jquery.com/Types/#Promise',
  62. Node: 'https://developer.mozilla.org/docs/Web/API/Node',
  63. number: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number',
  64. Object: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object',
  65. 'OO.EventEmitter': 'https://doc.wikimedia.org/oojs/master/OO.EventEmitter.html',
  66. 'OO.ui.mixin.ClippableElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.ClippableElement.html',
  67. 'OO.ui.mixin.FlaggedElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.FlaggedElement.html',
  68. 'OO.ui.mixin.FloatableElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.FloatableElement.html',
  69. 'OO.ui.mixin.GroupElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.GroupElement.html',
  70. 'OO.ui.mixin.IconElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.IconElement.html',
  71. 'OO.ui.mixin.IndicatorElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.IndicatorElement.html',
  72. 'OO.ui.mixin.LookupElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.LookupElement.html',
  73. 'OO.ui.mixin.PendingElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.PendingElement.html',
  74. 'OO.ui.mixin.RequestManager': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.RequestManager.html',
  75. 'OO.ui.mixin.TabIndexedElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.TabIndexedElement.html',
  76. 'OO.ui.ActionFieldLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ActionFieldLayout.html',
  77. 'OO.ui.ButtonGroupWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonGroupWidget.html',
  78. 'OO.ui.ButtonOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonOptionWidget.html',
  79. 'OO.ui.ButtonMenuSelectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonMenuSelectWidget.html',
  80. 'OO.ui.BookletLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.BookletLayout.html',
  81. 'OO.ui.ButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonWidget.html',
  82. 'OO.ui.CheckboxInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.CheckboxInputWidget',
  83. 'OO.ui.CopyTextLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.CopyTextLayout.html',
  84. 'OO.ui.DropdownInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.DropdownInputWidget.html',
  85. 'OO.ui.DropdownWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OO.ui.DropdownWidget.html',
  86. 'OO.ui.FieldLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.FieldLayout.html',
  87. 'OO.ui.FormLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.FormLayout.html',
  88. 'OO.ui.InputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.InputWidget.html',
  89. 'OO.ui.MenuOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuOptionWidget.html',
  90. 'OO.ui.MenuSectionOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuSectionOptionWidget.html',
  91. 'OO.ui.MenuSelectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuSelectWidget.html',
  92. 'OO.ui.MenuTagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuTagMultiselectWidget.html',
  93. 'OO.ui.MessageDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MessageDialog.html',
  94. 'OO.ui.OptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OptionWidget.html',
  95. 'OO.ui.PopupButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PopupButtonWidget.html',
  96. 'OO.ui.PopupWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PopupWidget.html',
  97. 'OO.ui.PageLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PageLayout.html',
  98. 'OO.ui.ProcessDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ProcessDialog.html',
  99. 'OO.ui.SearchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchWidget.html',
  100. 'OO.ui.SearchInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchInputWidget.html',
  101. 'OO.ui.SelectFileInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SelectFileInputWidget.html',
  102. 'OO.ui.TagItemWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagItemWidget.html',
  103. 'OO.ui.TagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagMultiselectWidget.html',
  104. 'OO.ui.TextInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TextInputWidget.html',
  105. 'OO.ui.ToggleButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToggleButtonWidget.html',
  106. 'OO.ui.ToggleSwitchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToggleSwitchWidget.html',
  107. 'OO.ui.Widget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.Widget.html',
  108. 'OO.ui.WindowManager': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.WindowManager.html',
  109. Promise: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise',
  110. RegExp: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp',
  111. Set: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set',
  112. string: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String',
  113. URLSearchParams: 'https://developer.mozilla.org/docs/Web/API/URLSearchParams'
  114. }
  115. }
  116. }
  117. };