?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
history | raw | HEAD
[JsonCodec] Hide TYPE_ANNOTATION from the unserialization methods
[mediawiki.git] / jsdoc.js
blob95fe6190d9560590ca381434ea99107f1f921946
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                 exclude: [
33                 ]
34         },
35         templates: {
36                 cleverLinks: true,
37                 default: {
38                         useLongnameInNav: true
39                 },
40                 wmf: {
41                         siteMap: {
42                                 sections: true
43                         },
44                         hideSections: [ 'Classes', 'Events' ],
45                         repository: 'https://gerrit.wikimedia.org/g/mediawiki/core/',
46                         linkMap: {
47                                 Array: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array',
48                                 Blob: 'https://developer.mozilla.org/docs/Web/API/Blob',
49                                 boolean: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean',
50                                 CSSStyleSheet: 'https://developer.mozilla.org/docs/Web/API/CSSStyleSheet',
51                                 Date: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date',
52                                 Event: 'https://developer.mozilla.org/docs/Web/API/Event',
53                                 File: 'https://developer.mozilla.org/docs/Web/API/File',
54                                 Function: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function',
55                                 HTMLElement: 'https://developer.mozilla.org/docs/Web/API/HTMLElement',
56                                 HTMLInputElement: 'https://developer.mozilla.org/docs/Web/API/HTMLInputElement',
57                                 HTMLStyleElement: 'https://developer.mozilla.org/docs/Web/API/HTMLStyleElement',
58                                 'JSON.parse': 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse',
59                                 jQuery: 'https://api.jquery.com/jQuery/',
60                                 'jQuery.fn': 'https://api.jquery.com/jQuery/',
61                                 'jQuery.Deferred': 'https://api.jquery.com/Types/#Deferred',
62                                 'jQuery.Event': 'https://api.jquery.com/Types/#Event',
63                                 'jQuery.Promise': 'https://api.jquery.com/Types/#Promise',
64                                 Node: 'https://developer.mozilla.org/docs/Web/API/Node',
65                                 number: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number',
66                                 Object: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object',
67                                 'OO.EventEmitter': 'https://doc.wikimedia.org/oojs/master/OO.EventEmitter.html',
68                                 'OO.Registry': 'https://doc.wikimedia.org/oojs/master/OO.Registry.html',
69                                 'OO.ui.mixin.ClippableElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.ClippableElement.html',
70                                 'OO.ui.mixin.FlaggedElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.FlaggedElement.html',
71                                 'OO.ui.mixin.FloatableElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.FloatableElement.html',
72                                 'OO.ui.mixin.GroupElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.GroupElement.html',
73                                 'OO.ui.mixin.IconElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.IconElement.html',
74                                 'OO.ui.mixin.IndicatorElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.IndicatorElement.html',
75                                 'OO.ui.mixin.LookupElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.LookupElement.html',
76                                 'OO.ui.mixin.PendingElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.PendingElement.html',
77                                 'OO.ui.mixin.RequestManager': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.RequestManager.html',
78                                 'OO.ui.mixin.TabIndexedElement': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.mixin.TabIndexedElement.html',
79                                 'OO.ui.ActionFieldLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ActionFieldLayout.html',
80                                 'OO.ui.ButtonGroupWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonGroupWidget.html',
81                                 'OO.ui.ButtonOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonOptionWidget.html',
82                                 'OO.ui.ButtonMenuSelectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonMenuSelectWidget.html',
83                                 'OO.ui.BookletLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.BookletLayout.html',
84                                 'OO.ui.ButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonWidget.html',
85                                 'OO.ui.CheckboxInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.CheckboxInputWidget',
86                                 'OO.ui.CopyTextLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.CopyTextLayout.html',
87                                 'OO.ui.DropdownInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.DropdownInputWidget.html',
88                                 'OO.ui.DropdownWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OO.ui.DropdownWidget.html',
89                                 'OO.ui.FieldLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.FieldLayout.html',
90                                 'OO.ui.FormLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.FormLayout.html',
91                                 'OO.ui.InputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.InputWidget.html',
92                                 'OO.ui.MenuOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuOptionWidget.html',
93                                 'OO.ui.MenuSectionOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuSectionOptionWidget.html',
94                                 'OO.ui.MenuSelectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuSelectWidget.html',
95                                 'OO.ui.MenuTagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuTagMultiselectWidget.html',
96                                 'OO.ui.MessageDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MessageDialog.html',
97                                 'OO.ui.OptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OptionWidget.html',
98                                 'OO.ui.PopupButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PopupButtonWidget.html',
99                                 'OO.ui.PopupWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PopupWidget.html',
100                                 'OO.ui.PageLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PageLayout.html',
101                                 'OO.ui.ProcessDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ProcessDialog.html',
102                                 'OO.ui.SearchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchWidget.html',
103                                 'OO.ui.SearchInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchInputWidget.html',
104                                 'OO.ui.SelectFileInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SelectFileInputWidget.html',
105                                 'OO.ui.TagItemWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagItemWidget.html',
106                                 'OO.ui.TagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagMultiselectWidget.html',
107                                 'OO.ui.TextInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TextInputWidget.html',
108                                 'OO.ui.ToggleButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToggleButtonWidget.html',
109                                 'OO.ui.ToggleSwitchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToggleSwitchWidget.html',
110                                 'OO.ui.Widget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.Widget.html',
111                                 'OO.ui.WindowManager': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.WindowManager.html',
112                                 Promise: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise',
113                                 RegExp: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp',
114                                 Set: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set',
115                                 string: 'https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String',
116                                 URLSearchParams: 'https://developer.mozilla.org/docs/Web/API/URLSearchParams'
117                         }
118                 }
119         }
120 };
MediaWiki Core