Page MenuHomePhabricator
Create Task
Maniphest T365114

Replace jsduck with JSDoc3 in UploadWizard
Open, Needs TriagePublic
Actions

Description

  • get jsdoc running on latest version (jsdoc.json, package.json)
  • add @class to any invisible classes
  • remove any strings after @class when the variable name matches the class name
  • search and replace @constructor with @class. JSDoc docs say they're synonyms
  • add docblocks to any invisible methods. examples:
    • mw.ApiUploadFormDataHandler.prototype.abort
    • mw.UploadWizardDetails.buildInterface()
  • fix invisible methods that have docblocks but still aren't showing up. examples:
    • $.fn.arrowSteps
    • mw.FlickrChecker.getPhotostream()
    • mw.UploadWizardDetails.attach()
  • eslint in the console, visit all the pages with docblock warnings, fix
    • @mixins
    • more than one @return declaration
    • @fires
    • @see {@link
  • npm run doc, fix all those
    • @inheritdoc
    • unknown link
    • no contribution link found
  • figure out how to document non-classes. examples:
    • resources/mw.canvas.js
    • resources/mw.errorDialog.js
  • check list of conversions in parent ticket. do those. examples:
    • @cfg
    • @inheritDoc foo
    • @property

Details

SubjectRepoBranchLines +/-
JSDoc: @mixins -> @mixesmediawiki/extensions/UploadWizardmaster+1 -1
JSDoc: load standard pluginsmediawiki/extensions/UploadWizardmaster+3 -0
JSDoc: fix some eslint warningsmediawiki/extensions/UploadWizardmaster+7 -3
JSDoc: convert @cfgmediawiki/extensions/UploadWizardmaster+20 -20
JSDoc: delete @chainablemediawiki/extensions/UploadWizardmaster+0 -4
JSDoc: convert most @mixins statementsmediawiki/extensions/UploadWizardmaster+11 -9
JSDoc: replace @constructor with @classmediawiki/extensions/UploadWizardmaster+12 -31
JSDoc: shorten @class statementsmediawiki/extensions/UploadWizardmaster+18 -18
JSDoc: add missing classesmediawiki/extensions/UploadWizardmaster+35 -0
Customize query in gerrit

Related Objects
Search...

Event Timeline

Novem_Linguae created this task.May 16 2024, 9:30 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMay 16 2024, 9:30 AM
Novem_Linguae added a parent task: T138401: Replace jsduck with JSDoc3 across all Wikimedia code bases.May 16 2024, 9:31 AM
Novem_Linguae updated the task description. (Show Details)May 16 2024, 9:37 AM
Novem_Linguae updated the task description. (Show Details)May 16 2024, 9:40 AM
Novem_Linguae updated the task description. (Show Details)May 16 2024, 9:47 AM
Novem_Linguae updated the task description. (Show Details)May 16 2024, 9:50 AM
gerritbot added a comment.May 16 2024, 9:54 AM

Change #1032408 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: add missing classes

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

gerritbot added a project: Patch-For-Review.May 16 2024, 9:54 AM
Novem_Linguae updated the task description. (Show Details)May 16 2024, 10:01 AM
gerritbot added a comment.May 16 2024, 10:04 AM

Change #1032409 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: replace @constructor with @class

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

gerritbot added a comment.May 16 2024, 10:11 AM

Change #1032412 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: shorten @class statements

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

Novem_Linguae updated the task description. (Show Details)May 16 2024, 10:13 AM
gerritbot added a comment.May 16 2024, 1:01 PM

Change #1032408 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: add missing classes

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

gerritbot added a comment.May 16 2024, 1:01 PM

Change #1032409 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: replace @constructor with @class

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

gerritbot added a comment.May 16 2024, 1:01 PM

Change #1032412 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: shorten @class statements

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

Maintenance_bot removed a project: Patch-For-Review.May 16 2024, 1:30 PM
gerritbot added a comment.May 16 2024, 1:31 PM

Change #1032489 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: convert most @mixins statements

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

gerritbot added a project: Patch-For-Review.May 16 2024, 1:31 PM
gerritbot added a comment.May 16 2024, 1:39 PM

Change #1032490 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: convert last @mixins statement

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

Novem_Linguae updated the task description. (Show Details)May 16 2024, 1:40 PM
ReleaseTaggerBot added a project: MW-1.43-notes (1.43.0-wmf.6; 2024-05-21).May 16 2024, 2:00 PM
gerritbot added a comment.May 17 2024, 2:35 PM

Change #1032489 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: convert most @mixins statements

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

apaskulin awarded a token.May 17 2024, 4:21 PM
gerritbot added a comment.Sun, May 26, 3:08 PM

Change #1035890 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: convert @cfg

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

Novem_Linguae updated the task description. (Show Details)Sun, May 26, 3:09 PM
Novem_Linguae updated the task description. (Show Details)Sun, May 26, 3:40 PM
gerritbot added a comment.Sun, May 26, 3:41 PM

Change #1035893 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: delete @chainable

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

Novem_Linguae updated the task description. (Show Details)Sun, May 26, 3:48 PM
gerritbot added a comment.Sun, May 26, 4:11 PM

Change #1035895 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: fix some eslint warnings

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

gerritbot added a comment.Sun, May 26, 4:33 PM

Change #1035896 had a related patch set uploaded (by Novem Linguae; author: Novem Linguae):

[mediawiki/extensions/UploadWizard@master] JSDoc: load standard plugins

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

gerritbot added a comment.Mon, May 27, 9:33 AM

Change #1035893 abandoned by Novem Linguae:

[mediawiki/extensions/UploadWizard@master] JSDoc: delete @chainable

Reason:

JSDoc supports @chainable, so no need to remove it

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

Novem_Linguae updated the task description. (Show Details)Mon, May 27, 9:33 AM
Novem_Linguae updated the task description. (Show Details)Tue, May 28, 12:56 AM
gerritbot added a comment.Tue, May 28, 11:28 AM

Change #1035890 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: convert @cfg

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

gerritbot added a comment.Tue, May 28, 11:45 AM

Change #1035895 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: fix some eslint warnings

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

ReleaseTaggerBot edited projects, added MW-1.43-notes (1.43.0-wmf.8; 2024-06-04); removed MW-1.43-notes (1.43.0-wmf.6; 2024-05-21).Tue, May 28, 1:01 PM
TheDJ subscribed.Wed, May 29, 1:45 PM

You are missing a few plugins in the JSDoc.json btw. The full list is now:

		"plugins/markdown",
		"node_modules/jsdoc-wmf-theme/plugins/summarize",
		"node_modules/jsdoc-wmf-theme/plugins/allow-dots-in-modules",
		"node_modules/jsdoc-wmf-theme/plugins/betterlinks"
gerritbot added a comment.Wed, May 29, 8:19 PM

Change #1035896 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: load standard plugins

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

Novem_Linguae mentioned this in T138401: Replace jsduck with JSDoc3 across all Wikimedia code bases.Thu, May 30, 10:46 AM
gerritbot added a comment.Sun, Jun 2, 8:46 PM

Change #1032490 merged by jenkins-bot:

[mediawiki/extensions/UploadWizard@master] JSDoc: @mixins -> @mixes

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

Maintenance_bot removed a project: Patch-For-Review.Sun, Jun 2, 9:30 PM
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