Page MenuHomePhabricator
Create Task
Maniphest T352308

Port remaining files to jsdoc in MediaWiki core
Closed, ResolvedPublic
Actions

Description

We currently maintain an exclude list of files that should not be included in jsdoc documentation. This was expedited to unblock use of ES6 in MediaWiki core. We hope to complete this porting by the next MediaWiki 1.42 Release, although CI will need to continue supporting JSDuck to generate the documentation for the REL1_39 branch which is supported until November 2025.

https://gerrit.wikimedia.org/g/mediawiki/core/+/29af4dd074ecc71c67bb9e530d82daddcf45c724/jsdoc.js#18

Migration plan

TODO

  1. Claim an item in the list by adding your name next to it.
  2. Make sure you have the latest version of MediaWiki core.
  3. Edit jsdoc.js, and move the file that you're migrating from the exclude section to the include section.
  4. Run npm run doc to update the local docs site.
  5. Open docs/js/index.html to view the site.
  6. Look through the local docs site, and find the elements from the file you're migrating. Does everything not marked as @private show up? Is it organized in a way that makes sense? You can check out the same content on the old JSDuck site for MediaWiki version 1.41 to see if the new site is presenting the same information in roughly the same way. If not, you'll need to adjust the tags to comply with JSDoc. See the chart on T138401 for specific mappings from JSDuck tags to JSDoc tags.
  7. Re-run npm run doc to preview your changes.

Tips and best practices:

  • Only public and stable methods should appear on the docs site.
  • Make sure every function has a description in the main section of the doc block.
  • Add an @example if you think they will be useful.
  • For singleton classes, use a @namespace tag.
  • Follow patterns in existing examples. Document hooks under namespace Hooks and jQuery plugins under jQueryPlugins namespace.
  • Fix any related jsdoc warnings.
  • You can run npx grunt eslint to find JSDoc errors.
  • If something isn't appearing on the docs site, you may need to add a @memberof tag with the namespace.

In order of priority:

Check the box once the patch is merged.

Phase 1

Phase 2

Phase 3 [https://gerrit.wikimedia.org/r/c/mediawiki/core/+/988733/]

The following modules do not appear to have public APIs. We should include them in jsdoc.json and make sure no changes happen to the documentation. You may need to add @ignore to a few things.

  • resources/src/mediawiki.page.image.pagination.js
  • resources/src/mediawiki.page.media.js
  • resources/src/mediawiki.special.block.js
  • resources/src/mediawiki.page.gallery.js
  • resources/src/mediawiki.userSuggest.js
  • resources/src/mediawiki.special.userrights.js
  • resources/src/mediawiki.special.search.commonsInterwikiWidget.js
  • resources/src/mediawiki.special.contributions.js
  • resources/src/mediawiki.checkboxtoggle.js
  • resources/src/mediawiki.special.changeslist.legend.js
  • resources/src/mediawiki.special.changeemail.js
  • resources/src/mediawiki.special.changecredentails.js
  • resources/src/mediawiki.misc-authed-pref
  • resources/src/mediawiki.toc
  • resources/src/mediawiki.pulsatingdot
  • resources/src/mediawiki.skinning
  • resources/src/mediawiki.special
  • resources/src/mediawiki.action
  • resources/src/mediawiki.action.edit
  • resources/src/mediawiki.special.changeslist
  • resources/src/mediawiki.apipretty
  • resources/src/mediawiki.special.changeslist.watchlistexpiry
  • resources/src/mediawiki.special.createaccount
  • resources/src/mediawiki.special.editrecovery
  • resources/src/mediawiki.special.search
  • resources/src/mediawiki.diff
  • resources/src/mediawiki.special.unwatchedPages
  • resources/src/mediawiki.editRecovery
  • resources/src/mediawiki.filewarning
  • resources/src/mediawiki.special.watchlist
  • resources/src/mediawiki.helplink
  • resources/src/mediawiki.htmlform
  • resources/src/mediawiki.tempUserBanner
  • resources/src/mediawiki.language.names
  • resources/src/mediawiki.misc-authed-curate
  • resources/src/mediawiki.misc-authed-ooui

Phase 4

Sign off steps

Files we didn't migrate

To do: For each of these, decide whether they should be excluded in the JSDoc config, documented, or marked with @ignore or @private tags

Details

SubjectRepoBranchLines +/-
docs: Fix module docs in JSDocmediawiki/coremaster+7 -1
docs: Remove remaining jsdoc exclusionsmediawiki/coremaster+0 -8
docs: Include moment in JSDocmediawiki/coremaster+5 -2
docs: Migrate convertmessagebox to JSDocmediawiki/coremaster+41 -55
docs: Migrate Vue wrapper to JSDocmediawiki/coremaster+22 -12
docs: Remove ApiSandbox class page from JSDocmediawiki/coremaster+1 -0
docs: Migrate mw.inspect to JSDocmediawiki/coremaster+19 -4
docs: Remove files that no longer existmediawiki/coremaster+0 -2
docs: Hide Events section in JSDocmediawiki/coremaster+1 -0
docs: Convert mw.Upload.Dialog and friends to jsdocmediawiki/coremaster+102 -92
Document mediawiki.htmlform.ooui classesmediawiki/coremaster+38 -3
Document rcfiltersmediawiki/coremaster+275 -204
docs: Various JSDoc fixesmediawiki/coremaster+24 -19
docs: Deduplicate JSDoc tags for mw.languagemediawiki/coremaster+3 -13
docs: Fix JSDoc descriptionsmediawiki/coremaster+4 -4
documentation: Convert mediawiki.ForeignApi from jsduck to jsdocmediawiki/coremaster+16 -9
mediawiki.widgets.datetime: Migrate to JSDocmediawiki/coremaster+143 -105
mw.messagePoster: Document in JSDocmediawiki/coremaster+39 -22
Documentation: $.msg (mediawiki.jqueryMsg)mediawiki/coremaster+164 -93
Documentation: mediawiki.page.gallery.slideshowmediawiki/coremaster+100 -68
Documentation: Add check for jsdocmediawiki/coremaster+11 -1
Documentation: Namespace searchSuggest typesmediawiki/coremaster+2 -2
mw.language: Document in JSDocmediawiki/coremaster+23 -21
jsdoc: Documenting mediawiki.libs.jpegmetamediawiki/coremaster+20 -2
Drop initialization of mw.GallerySlideshow propertiesmediawiki/coremaster+0 -0
Improve mediawiki.storage documentationmediawiki/coremaster+37 -50
Documentation: mediawiki.libs.jpegmetamediawiki/coremaster+34 -4
Documentation: Add documentation for mediawiki.searchSuggestmediawiki/coremaster+38 -6
docs: Ignore non-public APIsmediawiki/coremaster+13 -0
editRecovery: Remove private isSameAsOriginal function from docsmediawiki/coremaster+1 -0
docs: Format descriptionsmediawiki/coremaster+40 -40
Document mediawiki.widgets.visibleLengthLimit and resources/src/mediawiki.watchstar.widgetsmediawiki/coremaster+3 -3
Documentation: Add documentation for temporary user codemediawiki/coremaster+10 -2
Documentation: Port mw.Uri to JSDocmediawiki/coremaster+67 -66
Documentation: Add documentation for several trivial modulesmediawiki/coremaster+31 -15
Documentation: Move to exclude listmediawiki/coremaster+45 -98
Documentation: mw.widgetmediawiki/coremaster+210 -197
Document jQuery pluginsmediawiki/coremaster+79 -50
Document mw.Feedbackmediawiki/coremaster+25 -13
Document mediawiki.templatemediawiki/coremaster+53 -10
Documentation: Document mediawiki.page.readymediawiki/coremaster+60 -104
mediawiki.page.watch.ajax: document modulemediawiki/coremaster+65 -41
jquery.cookie: Remove misleading jsdoc commentmediawiki/coremaster+0 -6
mediawiki.page.watch.ajax: Document type name as "callback" with @typedefmediawiki/coremaster+10 -8
mediawiki.base: replace @chainable with @return typemediawiki/coremaster+2 -2
Correctly document missing properties/methodsmediawiki/coremaster+27 -12
Gruntfile: Remove now-unused copy:jsdoc commandmediawiki/coremaster+0 -161
documentation: Convert mw.Upload and mw.ForeignUpload to jsdocmediawiki/coremaster+56 -13
mediawiki.page.preview: document module in JSDocmediawiki/coremaster+49 -27
mediawiki.storage: Document in jsdocmediawiki/coremaster+61 -43
Fix mw.UriRelative documentationmediawiki/coremaster+1 -2
Document types in mw.notification.defaultsmediawiki/coremaster+26 -34
documentation: Convert mediawiki.api from jsduck to jsdocmediawiki/coremaster+121 -191
mediawiki.cookie: Remove unsupported @mixins directivemediawiki/coremaster+0 -5
jsdoc.types.js: document commonly used hooks from mediawiki.page.readymediawiki/coremaster+60 -0
Documentation: Port mw.user to JSDocmediawiki/coremaster+15 -15
mw.Title: Document in jsdocmediawiki/coremaster+62 -49
mw.Title: Improve documentationmediawiki/coremaster+44 -43
mediawiki:string: Document modulemediawiki/coremaster+28 -22
mediawiki.util: Correctly document parseImageUrl return typemediawiki/coremaster+15 -11
Documentation: Migrate mw.experiments docs to JSDocmediawiki/coremaster+8 -12
Documentation: Migrate jQuery lengthLimit plugin to JSDocmediawiki/coremaster+13 -11
Documentation: normalize descriptionsmediawiki/coremaster+15 -13
Documentation: Expand the documentation in jsdocmediawiki/coremaster+218 -135
Show related patches Customize query in gerrit

Related Objects
Search...

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes
gerritbot added a comment.Feb 13 2024, 4:22 PM

Change 1003015 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/core@master] Documentation: Namespace searchSuggest types

https://gerrit.wikimedia.org/r/1003015

gerritbot added a comment.Feb 13 2024, 4:45 PM

Change 1002641 merged by jenkins-bot:

[mediawiki/core@master] mw.language: Document in JSDoc

https://gerrit.wikimedia.org/r/1002641

Jdlrobson updated the task description. (Show Details)Feb 13 2024, 4:54 PM
Jdlrobson updated the task description. (Show Details)
gerritbot added a comment.Feb 13 2024, 4:57 PM

Change 1003015 merged by jenkins-bot:

[mediawiki/core@master] Documentation: Namespace searchSuggest types

https://gerrit.wikimedia.org/r/1003015

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.19; 2024-02-20); removed MW-1.42-notes (1.42.0-wmf.18; 2024-02-13).Feb 13 2024, 5:00 PM
gerritbot added a comment.Feb 13 2024, 5:13 PM

Change 1003046 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/core@master] mw.messagePoster: Document in JSDoc

https://gerrit.wikimedia.org/r/1003046

gerritbot added a comment.Feb 14 2024, 12:18 AM

Change 995275 merged by jenkins-bot:

[mediawiki/core@master] Documentation: mediawiki.page.gallery.slideshow

https://gerrit.wikimedia.org/r/995275

Jdlrobson updated the task description. (Show Details)Feb 14 2024, 12:19 AM
gerritbot added a comment.Feb 14 2024, 12:28 AM

Change 997949 abandoned by Jdlrobson:

[mediawiki/core@master] Documentation: Add check for jsdoc

Reason:

See https://phabricator.wikimedia.org/T357489

https://gerrit.wikimedia.org/r/997949

gerritbot added a comment.Feb 14 2024, 9:51 PM

Change 1003046 merged by jenkins-bot:

[mediawiki/core@master] mw.messagePoster: Document in JSDoc

https://gerrit.wikimedia.org/r/1003046

Jdlrobson updated the task description. (Show Details)Feb 14 2024, 9:54 PM
gerritbot added a comment.Feb 14 2024, 11:31 PM

Change 988730 merged by jenkins-bot:

[mediawiki/core@master] Documentation: $.msg (mediawiki.jqueryMsg)

https://gerrit.wikimedia.org/r/988730

Jdlrobson updated the task description. (Show Details)Feb 14 2024, 11:50 PM
gerritbot added a comment.Feb 15 2024, 3:44 PM

Change 1003785 had a related patch set uploaded (by Anne Tomasevich; author: Anne Tomasevich):

[mediawiki/core@master] mediawiki.widgets.datetime: Migrate to JSDoc

https://gerrit.wikimedia.org/r/1003785

AnneT updated the task description. (Show Details)Feb 15 2024, 3:45 PM
Esanders unsubscribed.Feb 15 2024, 3:56 PM
gerritbot added a comment.Feb 15 2024, 7:42 PM

Change 1003785 merged by jenkins-bot:

[mediawiki/core@master] mediawiki.widgets.datetime: Migrate to JSDoc

https://gerrit.wikimedia.org/r/1003785

Jdlrobson updated the task description. (Show Details)Feb 15 2024, 9:17 PM
apaskulin updated the task description. (Show Details)Feb 15 2024, 10:37 PM
Jdlrobson closed subtask T354716: Cryptic warnings inside publish.js on valid JSDoc as Declined.Feb 15 2024, 10:38 PM
gerritbot added a comment.Feb 16 2024, 4:10 AM

Change 1003992 had a related patch set uploaded (by Catrope; author: Catrope):

[mediawiki/core@master] docs; Convert mw.Upload.Dialog and friends to jsdoc

https://gerrit.wikimedia.org/r/1003992

Catrope updated the task description. (Show Details)Feb 16 2024, 4:11 AM
gerritbot added a comment.Feb 16 2024, 10:12 PM

Change 983280 merged by jenkins-bot:

[mediawiki/core@master] documentation: Convert mediawiki.ForeignApi from jsduck to jsdoc

https://gerrit.wikimedia.org/r/983280

gerritbot added a comment.Feb 16 2024, 10:49 PM

Change 1004261 had a related patch set uploaded (by Jdlrobson; author: Jdlrobson):

[mediawiki/core@master] Document mediawiki.htmlform.ooui classes

https://gerrit.wikimedia.org/r/1004261

Jdlrobson updated the task description. (Show Details)Feb 16 2024, 10:50 PM
Nardog added a comment.EditedFeb 22 2024, 7:23 AM

The textSelection methods are marked as private and thus not showing up in the documentation. They should be surfaced one way or another as they are APIs meant to be used by consumers.

gerritbot added a comment.Feb 22 2024, 7:17 PM

Change 1005823 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Fix JSDoc descriptions

https://gerrit.wikimedia.org/r/1005823

gerritbot added a comment.Feb 22 2024, 7:49 PM

Change 1005823 merged by jenkins-bot:

[mediawiki/core@master] docs: Fix JSDoc descriptions

https://gerrit.wikimedia.org/r/1005823

gerritbot added a comment.Feb 22 2024, 8:34 PM

Change 1005832 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Deduplicate JSDoc tags for mw.language

https://gerrit.wikimedia.org/r/1005832

Jdlrobson mentioned this in T358290: JSDoc textSelection methods being marked as private.Feb 22 2024, 8:57 PM
In T352308#9566377, @Nardog wrote:

The documentation for the textSelection methods are marked as private and thus not showing up. They should be surfaced one way or another as they are APIs meant to be used by consumers.

I created T358290 so this doesn't get lost. Thanks for the report!

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.20; 2024-02-27); removed MW-1.42-notes (1.42.0-wmf.19; 2024-02-20).Feb 23 2024, 1:00 AM
gerritbot added a comment.Feb 23 2024, 1:29 AM

Change 1005832 merged by jenkins-bot:

[mediawiki/core@master] docs: Deduplicate JSDoc tags for mw.language

https://gerrit.wikimedia.org/r/1005832

Nardog added a comment.Feb 23 2024, 2:57 AM

Can you re-surface mw.loader.addStyleTag()? It's been quite handy, it's used a lot, and the doc for mw.util.addCSS() even mentions it as an alternative.

apaskulin updated the task description. (Show Details)Feb 23 2024, 8:52 PM
apaskulin mentioned this in T358391: Clarify stability of mw.loader.addStyleTag() in documentation.Feb 23 2024, 9:24 PM
In T352308#9570940, @Nardog wrote:

Can you re-surface mw.loader.addStyleTag()? It's been quite handy, it's used a lot, and the doc for mw.util.addCSS() even mentions it as an alternative.

Thanks for the report! I've opened T358391 for this.

Jdlrobson assigned this task to Catrope.Feb 23 2024, 9:55 PM

Hey Roan seems like all work here is on you (and then me once the patches have been resubmitted). Please assign to me when you've reviewed my patch and posted up new versions of your patch so we can get this over the finish line.

gerritbot added a comment.Feb 24 2024, 11:57 AM

Change 1006130 had a related patch set uploaded (by Tacsipacsi; author: Tacsipacsi):

[mediawiki/core@master] docs: Various JSDoc fixes

https://gerrit.wikimedia.org/r/1006130

apaskulin closed subtask T356546: Update the MediaWiki core JSDoc homepage as Resolved.Feb 26 2024, 5:32 PM
matmarex added a comment.Feb 26 2024, 9:34 PM

FYI, I added support to Patch demo to generate the JSDoc documentation as well, to make these patches easier to test and review: https://gitlab.wikimedia.org/repos/ci-tools/patchdemo/-/merge_requests/603. There will be a link to the generated documentation on the main page of every new wiki. For example: https://patchdemo.wmflabs.org/wikis/147380bd91. (I hope it's better late than never :) )

gerritbot added a comment.Feb 26 2024, 10:02 PM

Change 1006130 merged by jenkins-bot:

[mediawiki/core@master] docs: Various JSDoc fixes

https://gerrit.wikimedia.org/r/1006130

apaskulin added a comment.Feb 27 2024, 8:48 PM
In T352308#9578249, @matmarex wrote:

FYI, I added support to Patch demo to generate the JSDoc documentation as well, to make these patches easier to test and review: https://gitlab.wikimedia.org/repos/ci-tools/patchdemo/-/merge_requests/603. There will be a link to the generated documentation on the main page of every new wiki. For example: https://patchdemo.wmflabs.org/wikis/147380bd91. (I hope it's better late than never :) )

This is awesome! Thanks, @matmarex! I've added a note about this to the wiki page.

gerritbot added a comment.Feb 28 2024, 7:25 PM

Change 991655 merged by jenkins-bot:

[mediawiki/core@master] Document rcfilters

https://gerrit.wikimedia.org/r/991655

gerritbot added a comment.Feb 28 2024, 7:31 PM

Change 1004261 merged by jenkins-bot:

[mediawiki/core@master] Document mediawiki.htmlform.ooui classes

https://gerrit.wikimedia.org/r/1004261

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.21; 2024-03-05); removed MW-1.42-notes (1.42.0-wmf.20; 2024-02-27).Feb 28 2024, 9:00 PM
gerritbot added a comment.Feb 28 2024, 11:45 PM

Change 1007457 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Hide Events section in JSDoc

https://gerrit.wikimedia.org/r/1007457

PatchDemoBot added a comment.Feb 28 2024, 11:49 PM

Test wiki created on Patch demo by APaskulin (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/9395d1c804/w

Jdlrobson updated the task description. (Show Details)Feb 29 2024, 1:29 AM
Jdlrobson updated the task description. (Show Details)
Jdlrobson reassigned this task from Catrope to apaskulin.Feb 29 2024, 1:31 AM

The epic part of this is now done! Assigning to you to go over the fruits of our labour and to create new follow up tickets for any issues that remain in the documentation.

This might also be a good time to check in with the community and ask the question:

  • What's missing from the documentation that's important to you?
  • What issues do you notice with the existing documentation?
  • How can we improve on the documentation?
gerritbot added a comment.Feb 29 2024, 1:50 AM

Change 1003992 merged by jenkins-bot:

[mediawiki/core@master] docs: Convert mw.Upload.Dialog and friends to jsdoc

https://gerrit.wikimedia.org/r/1003992

gerritbot added a comment.Mar 1 2024, 12:08 AM

Change 1007457 abandoned by Alex Paskulin:

[mediawiki/core@master] docs: Hide Events section in JSDoc

Reason:

Per review comments

https://gerrit.wikimedia.org/r/1007457

apaskulin updated the task description. (Show Details)Mar 1 2024, 3:06 AM
gerritbot added a comment.Mar 5 2024, 11:10 PM

Change 1008973 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Remove files that no longer exist

https://gerrit.wikimedia.org/r/1008973

apaskulin updated the task description. (Show Details)Mar 5 2024, 11:14 PM
gerritbot added a comment.Mar 5 2024, 11:54 PM

Change 1008973 merged by jenkins-bot:

[mediawiki/core@master] docs: Remove files that no longer exist

https://gerrit.wikimedia.org/r/1008973

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.22; 2024-03-12); removed MW-1.42-notes (1.42.0-wmf.21; 2024-03-05).Mar 6 2024, 1:00 AM
gerritbot added a comment.Mar 7 2024, 1:19 AM

Change 1009368 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Include files without JSDoc comments

https://gerrit.wikimedia.org/r/1009368

gerritbot added a comment.Mar 7 2024, 1:29 AM

Change 1009369 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Migrate convertmessagebox to JSDoc

https://gerrit.wikimedia.org/r/1009369

gerritbot added a comment.Mar 7 2024, 2:03 AM

Change 1009372 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Include moment in JSDoc

https://gerrit.wikimedia.org/r/1009372

apaskulin updated the task description. (Show Details)Mar 7 2024, 2:14 AM
matmarex mentioned this in T358940: GerritBot comments for 7-digit Gerrit changes conflict with Diffusion commit hashes.Mar 7 2024, 12:07 PM
gerritbot added a comment.Mar 7 2024, 5:21 PM

Change 1009576 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Migrate Vue wrapper to JSDoc

https://gerrit.wikimedia.org/r/1009576

gerritbot added a comment.Mar 7 2024, 5:30 PM

Change 1009578 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Migrate ApiSandbox to JSDoc

https://gerrit.wikimedia.org/r/1009578

gerritbot added a comment.Mar 7 2024, 5:38 PM

Change rEOAU1009580050bf had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Migrate mw.inspect to JSDoc

https://gerrit.wikimedia.org/r/1009580

apaskulin updated the task description. (Show Details)Mar 7 2024, 5:41 PM
gerritbot added a comment.Mar 8 2024, 12:52 AM

Change rEOAU1009580050bf merged by jenkins-bot:

[mediawiki/core@master] docs: Migrate mw.inspect to JSDoc

https://gerrit.wikimedia.org/r/1009580

apaskulin updated the task description. (Show Details)Mar 8 2024, 1:01 AM
PatchDemoBot added a comment.Mar 8 2024, 1:07 AM

Test wiki created on Patch demo by APaskulin (WMF) using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/af1f262be9/w

gerritbot added a comment.Mar 8 2024, 3:52 PM

Change 1009578 merged by jenkins-bot:

[mediawiki/core@master] docs: Remove ApiSandbox class page from JSDoc

https://gerrit.wikimedia.org/r/1009578

apaskulin updated the task description. (Show Details)Mar 11 2024, 4:33 PM
gerritbot added a comment.Mar 11 2024, 5:07 PM

Change 1009576 merged by jenkins-bot:

[mediawiki/core@master] docs: Migrate Vue wrapper to JSDoc

https://gerrit.wikimedia.org/r/1009576

apaskulin updated the task description. (Show Details)Mar 15 2024, 11:20 PM
apaskulin updated the task description. (Show Details)Mar 15 2024, 11:41 PM
gerritbot added a comment.Mar 15 2024, 11:47 PM

Change 1009369 merged by jenkins-bot:

[mediawiki/core@master] docs: Migrate convertmessagebox to JSDoc

https://gerrit.wikimedia.org/r/1009369

gerritbot added a comment.Mar 15 2024, 11:49 PM

Change 1009372 merged by jenkins-bot:

[mediawiki/core@master] docs: Include moment in JSDoc

https://gerrit.wikimedia.org/r/1009372

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.23; 2024-03-19); removed MW-1.42-notes (1.42.0-wmf.22; 2024-03-12).Mar 16 2024, 1:00 AM
gerritbot added a comment.Mar 20 2024, 7:32 PM

Change 1013131 had a related patch set uploaded (by Alex Paskulin; author: Alex Paskulin):

[mediawiki/core@master] docs: Fix module docs in JSDoc

https://gerrit.wikimedia.org/r/1013131

gerritbot added a comment.Mar 21 2024, 11:03 PM

Change #1009368 merged by jenkins-bot:

[mediawiki/core@master] docs: Remove remaining jsdoc exclusions

https://gerrit.wikimedia.org/r/1009368

ReleaseTaggerBot edited projects, added MW-1.42-notes (1.42.0-wmf.24; 2024-03-26); removed MW-1.42-notes (1.42.0-wmf.23; 2024-03-19).Mar 22 2024, 12:00 AM
gerritbot added a comment.Mar 22 2024, 12:38 AM

Change #1013131 merged by jenkins-bot:

[mediawiki/core@master] docs: Fix module docs in JSDoc

https://gerrit.wikimedia.org/r/1013131

apaskulin updated the task description. (Show Details)Mar 22 2024, 5:35 PM
apaskulin updated the task description. (Show Details)Mar 29 2024, 4:29 PM
apaskulin closed subtask T353560: Fix on-wiki links to MediaWiki JSDoc site as Resolved.Mar 29 2024, 8:35 PM
apaskulin closed this task as Resolved.Mar 29 2024, 8:51 PM
apaskulin moved this task from Backlog to Done on the Tech-Docs-Team board.

All files have been migrated to JSDoc and the review has been completed 🎉 Further work will be handled in separate tasks. Thanks to everyone who contributed! Check out the fully migrated docs: https://doc.wikimedia.org/mediawiki-core/master/js/

TheDJ awarded a token.Mar 29 2024, 9:07 PM
Volker_E awarded a token.Mar 29 2024, 10:24 PM
Jack_who_built_the_house mentioned this in T366400: MediaWiki core's docs don't show members inherited from OOUI.Jun 1 2024, 8:15 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits