Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
wiki.techinc.nl/jsdoc.js

93 lines
5.3 KiB
JavaScript
Raw Normal View History

Add jsdoc with jsdoc-wmf-theme jsduck is preventing us from using ES6 syntax and has not been supported for some time. It is also difficult to setup locally due its use of Ruby. Introduce jsdoc and remove jsduck per T138401#9335987 Link to static copy of jsduck explaining the state This does the bare minimum - the docs are built to the folder docs/js/index.html and only one module is ported over to allow us to provide feedback on the end result. Bug: T138401 Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
2023-07-11 15:52:05 +00:00
'use strict';
module.exports = {
opts: {
destination: 'docs/js',
package: 'resources/package.json',
pedantic: true,
readme: 'resources/README.md',
recurse: true,
template: 'node_modules/jsdoc-wmf-theme'
},
plugins: [
jsdoc: Support dots in '@module <name>' and '@exports <name>' JSDoc mangles dots in '@module <name>' and '@exports <name>' annotations: https://github.com/jsdoc/jsdoc/issues/1157 Work around this bug with a small plugin. Update '@link', '@memberof' etc. annotations that had to be written using incorrect names to work. (Those annotations are not affected by the bug, so we had to mangle them by hand.) Bug: T356913 Change-Id: I68bfb7be0f7d1d49901a1d5ceebc618771380b35
2024-02-07 00:29:52 +00:00
'jsdoc-plugin-allow-dots-in-modules',
jsdoc: Use the summarize plugin Bug: T344861 Change-Id: I699cd2a5584e78065594d6debbb6f2a2e6d1f7c4
2023-12-07 01:30:21 +00:00
'plugins/markdown',
'plugins/summarize'
Add jsdoc with jsdoc-wmf-theme jsduck is preventing us from using ES6 syntax and has not been supported for some time. It is also difficult to setup locally due its use of Ruby. Introduce jsdoc and remove jsduck per T138401#9335987 Link to static copy of jsduck explaining the state This does the bare minimum - the docs are built to the folder docs/js/index.html and only one module is ported over to allow us to provide feedback on the end result. Bug: T138401 Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
2023-07-11 15:52:05 +00:00
],
source: {
include: [
Documentation: Move to exclude list * Generate documentation for all files in resources/src * Include all files documented in phase 3 as not having public APIs. Add @ignore tag to documentation that shows up in published document. Bug: T352308 Change-Id: I5d643d815ffa2f578d12bb9ca70e26558a442c32
2024-01-08 22:03:11 +00:00
'resources/src/'
Add jsdoc with jsdoc-wmf-theme jsduck is preventing us from using ES6 syntax and has not been supported for some time. It is also difficult to setup locally due its use of Ruby. Introduce jsdoc and remove jsduck per T138401#9335987 Link to static copy of jsduck explaining the state This does the bare minimum - the docs are built to the folder docs/js/index.html and only one module is ported over to allow us to provide feedback on the end result. Bug: T138401 Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
2023-07-11 15:52:05 +00:00
],
exclude: [
/* The following modules are temporarily disabled as we haven't
got round to reviewing them and incorporating them into the documentation page yet. */
'resources/src/codex',
'resources/src/codex-search',
'resources/src/mediawiki.ForeignStructuredUpload.BookletLayout',
'resources/src/mediawiki.router',
'resources/src/mediawiki.Upload.BookletLayout',
'resources/src/mediawiki.Upload.Dialog.js',
'resources/src/mediawiki.language.specialCharacters',
'resources/src/moment',
'resources/src/oojs-global.js',
'resources/src/mediawiki.notification.convertmessagebox.js',
'resources/src/ooui-local.js',
'resources/src/vue'
]
},
templates: {
cleverLinks: true,
default: {
useLongnameInNav: true
},
wmf: {
linkMap: {
Array: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array',
Blob: 'https://developer.mozilla.org/en-US/docs/Web/API/Blob',
CSSStyleSheet: 'https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet',
Documentation: Document mediawiki.page.ready Bug: T352308 Change-Id: I1947d923a20aff08fabec486dc82b740b12a0e4a
2023-12-19 19:41:19 +00:00
Event: 'https://developer.mozilla.org/en-US/docs/Web/API/Event',
Add jsdoc with jsdoc-wmf-theme jsduck is preventing us from using ES6 syntax and has not been supported for some time. It is also difficult to setup locally due its use of Ruby. Introduce jsdoc and remove jsduck per T138401#9335987 Link to static copy of jsduck explaining the state This does the bare minimum - the docs are built to the folder docs/js/index.html and only one module is ported over to allow us to provide feedback on the end result. Bug: T138401 Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
2023-07-11 15:52:05 +00:00
File: 'https://developer.mozilla.org/en-US/docs/Web/API/File',
HTMLElement: 'https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement',
HTMLInputElement: 'https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement',
documentation: Convert mediawiki.api from jsduck to jsdoc Bug: T352308 Change-Id: Ia9320213e2208bb45a7f162b5b5c385fbed09599
2023-12-13 23:04:32 +00:00
'JSON.parse': 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse',
Add jsdoc with jsdoc-wmf-theme jsduck is preventing us from using ES6 syntax and has not been supported for some time. It is also difficult to setup locally due its use of Ruby. Introduce jsdoc and remove jsduck per T138401#9335987 Link to static copy of jsduck explaining the state This does the bare minimum - the docs are built to the folder docs/js/index.html and only one module is ported over to allow us to provide feedback on the end result. Bug: T138401 Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
2023-07-11 15:52:05 +00:00
jQuery: 'https://api.jquery.com/jQuery/',
'jQuery.fn': 'https://api.jquery.com/jQuery/',
Documentation: Add documentation for mediawiki.searchSuggest Bug: T352308 Change-Id: I13360bb3344e6243cd461c5af19e56a7ba38510c
2024-02-02 17:10:51 +00:00
'jQuery.Deferred': 'https://api.jquery.com/Types/#Deferred',
Add jsdoc with jsdoc-wmf-theme jsduck is preventing us from using ES6 syntax and has not been supported for some time. It is also difficult to setup locally due its use of Ruby. Introduce jsdoc and remove jsduck per T138401#9335987 Link to static copy of jsduck explaining the state This does the bare minimum - the docs are built to the folder docs/js/index.html and only one module is ported over to allow us to provide feedback on the end result. Bug: T138401 Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
2023-07-11 15:52:05 +00:00
'jQuery.Event': 'https://api.jquery.com/Types/#Event',
'jQuery.Promise': 'https://api.jquery.com/Types/#Promise',
Documentation: Document mediawiki.page.ready Bug: T352308 Change-Id: I1947d923a20aff08fabec486dc82b740b12a0e4a
2023-12-19 19:41:19 +00:00
Node: 'https://developer.mozilla.org/en-US/docs/Web/API/Node',
Document mediawiki.htmlform.ooui classes Bug: T352308 Change-Id: I6b55687e2110e053e0db6a09e61d5f477bdf5ebd
2024-02-16 22:48:53 +00:00
'OO.ui.ActionFieldLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ActionFieldLayout.html',
Document rcfilters * Mark @events as @ignore and move description to top of block * Replace @cfg with @param * Add additional OOUI classes * Add full stops to ends of sentences * @ignore various functions Bug: T352308 Change-Id: Id68733a2283f3a61f913ee1eb7b32f9a8911ca3d
2024-01-18 20:55:45 +00:00
'OO.ui.ButtonGroupWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonGroupWidget.html',
'OO.ui.ButtonOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonOptionWidget.html',
'OO.ui.ButtonMenuSelectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonMenuSelectWidget.html',
mediawiki.widgets.datetime: Migrate to JSDoc Bug: T352308 Change-Id: I316d9bb96000974d9dc8ce65a52cf6f913c20c6b
2024-02-15 15:43:38 +00:00
'OO.ui.ButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ButtonWidget.html',
Document rcfilters * Mark @events as @ignore and move description to top of block * Replace @cfg with @param * Add additional OOUI classes * Add full stops to ends of sentences * @ignore various functions Bug: T352308 Change-Id: Id68733a2283f3a61f913ee1eb7b32f9a8911ca3d
2024-01-18 20:55:45 +00:00
'OO.ui.CheckboxInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.CheckboxInputWidget',
Update links to OOUI documentation OOUI uses JSDoc now (T185396). Update links from the JSDuck format. Remove an unnecessary @see that was pointing to a private method with no documentation. Change-Id: I26b0f0d586f4ba23974cadd34662d3ffc7f8ccba
2024-01-13 00:20:28 +00:00
'OO.ui.CopyTextLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.CopyTextLayout.html',
'OO.ui.DropdownInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.DropdownInputWidget.html',
Document rcfilters * Mark @events as @ignore and move description to top of block * Replace @cfg with @param * Add additional OOUI classes * Add full stops to ends of sentences * @ignore various functions Bug: T352308 Change-Id: Id68733a2283f3a61f913ee1eb7b32f9a8911ca3d
2024-01-18 20:55:45 +00:00
'OO.ui.DropdownWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OO.ui.DropdownWidget.html',
Document mediawiki.htmlform.ooui classes Bug: T352308 Change-Id: I6b55687e2110e053e0db6a09e61d5f477bdf5ebd
2024-02-16 22:48:53 +00:00
'OO.ui.FieldLayout': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.FieldLayout.html',
mediawiki.widgets.datetime: Migrate to JSDoc Bug: T352308 Change-Id: I316d9bb96000974d9dc8ce65a52cf6f913c20c6b
2024-02-15 15:43:38 +00:00
'OO.ui.InputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.InputWidget.html',
Update links to OOUI documentation OOUI uses JSDoc now (T185396). Update links from the JSDuck format. Remove an unnecessary @see that was pointing to a private method with no documentation. Change-Id: I26b0f0d586f4ba23974cadd34662d3ffc7f8ccba
2024-01-13 00:20:28 +00:00
'OO.ui.MenuOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuOptionWidget.html',
Document rcfilters * Mark @events as @ignore and move description to top of block * Replace @cfg with @param * Add additional OOUI classes * Add full stops to ends of sentences * @ignore various functions Bug: T352308 Change-Id: Id68733a2283f3a61f913ee1eb7b32f9a8911ca3d
2024-01-18 20:55:45 +00:00
'OO.ui.MenuSectionOptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuSectionOptionWidget.html',
'OO.ui.MenuSelectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuSelectWidget.html',
Update links to OOUI documentation OOUI uses JSDoc now (T185396). Update links from the JSDuck format. Remove an unnecessary @see that was pointing to a private method with no documentation. Change-Id: I26b0f0d586f4ba23974cadd34662d3ffc7f8ccba
2024-01-13 00:20:28 +00:00
'OO.ui.MenuTagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MenuTagMultiselectWidget.html',
'OO.ui.MessageDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.MessageDialog.html',
'OO.ui.OptionWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.OptionWidget.html',
Document rcfilters * Mark @events as @ignore and move description to top of block * Replace @cfg with @param * Add additional OOUI classes * Add full stops to ends of sentences * @ignore various functions Bug: T352308 Change-Id: Id68733a2283f3a61f913ee1eb7b32f9a8911ca3d
2024-01-18 20:55:45 +00:00
'OO.ui.PopupButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PopupButtonWidget.html',
'OO.ui.PopupWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.PopupWidget.html',
Update links to OOUI documentation OOUI uses JSDoc now (T185396). Update links from the JSDuck format. Remove an unnecessary @see that was pointing to a private method with no documentation. Change-Id: I26b0f0d586f4ba23974cadd34662d3ffc7f8ccba
2024-01-13 00:20:28 +00:00
'OO.ui.ProcessDialog': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ProcessDialog.html',
'OO.ui.SearchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchWidget.html',
'OO.ui.SearchInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.SearchInputWidget.html',
'OO.ui.TagItemWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagItemWidget.html',
'OO.ui.TagMultiselectWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TagMultiselectWidget.html',
'OO.ui.TextInputWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.TextInputWidget.html',
Document rcfilters * Mark @events as @ignore and move description to top of block * Replace @cfg with @param * Add additional OOUI classes * Add full stops to ends of sentences * @ignore various functions Bug: T352308 Change-Id: Id68733a2283f3a61f913ee1eb7b32f9a8911ca3d
2024-01-18 20:55:45 +00:00
'OO.ui.ToggleButtonWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToggleButtonWidget.html',
Update links to OOUI documentation OOUI uses JSDoc now (T185396). Update links from the JSDuck format. Remove an unnecessary @see that was pointing to a private method with no documentation. Change-Id: I26b0f0d586f4ba23974cadd34662d3ffc7f8ccba
2024-01-13 00:20:28 +00:00
'OO.ui.ToggleSwitchWidget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.ToggleSwitchWidget.html',
'OO.ui.Widget': 'https://doc.wikimedia.org/oojs-ui/master/js/OO.ui.Widget.html',
Add jsdoc with jsdoc-wmf-theme jsduck is preventing us from using ES6 syntax and has not been supported for some time. It is also difficult to setup locally due its use of Ruby. Introduce jsdoc and remove jsduck per T138401#9335987 Link to static copy of jsduck explaining the state This does the bare minimum - the docs are built to the folder docs/js/index.html and only one module is ported over to allow us to provide feedback on the end result. Bug: T138401 Change-Id: I1a351ac5aec731bb79a877023ac10988ec3ec786
2023-07-11 15:52:05 +00:00
Promise: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise',
Set: 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set',
URLSearchParams: 'https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams'
}
}
}
};
Reference in a new issue Copy permalink