Page MenuHomePhabricator

Mass refactoring of JSDuck-only tags
Open, Needs TriagePublic

Description

Background

Wikimedia is switching from JavaScript documentation engine JSDuck to JSDoc. All JavaScript docblocks that use tags and syntax unique to JSDuck should be switched to tags and syntax supported by JSDoc.

Tags to refactor

I diffed all the JSDuck tags and all the JSDoc tags, and came up with the following list of tags that only occur in JSDuck (and therefore should be mass refactored):

https://www.mediawiki.org/wiki/JSDoc#Converting_from_JSDuck_to_JSDoc

Doing codesearches of each tag, the following are present in our codebases:

Let me know if one of these tags should not be refactored (e.g. we support it via a plugin (@chainable), or we want to keep it because it makes the code more readable (@constructor))

Event Timeline

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Change #1037755 merged by jenkins-bot:

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

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

Change #1037751 merged by jenkins-bot:

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

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

Change #1037757 merged by jenkins-bot:

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

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

Change #1032490 merged by jenkins-bot:

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

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

Change #1037754 merged by jenkins-bot:

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

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

Change #1037752 merged by jenkins-bot:

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

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

Change #1037753 merged by jenkins-bot:

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

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

Change #1037756 merged by jenkins-bot:

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

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

Change #1037815 merged by jenkins-bot:

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

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