Support dots in module names
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	Jdlrobson
	Feb 7 2024, 8:41 PM

Description

@matmarex has proposed a plugin that allows dots in module names:
jsdoc-plugin-allow-dots-in-modules

This would fix the annoying @memberof mediawiki.module:String workaround we've been using and we'd be able to do @memberof module:mediawiki.String

This doesn't seem to impact URLs e.g. file:///Users/jdlrobson/git/core/docs/js/mediawiki.page.module_preview.html would still be the URL

This would also allow us to document modules that themselves are functions (see conversation in https://gerrit.wikimedia.org/r/c/mediawiki/core/+/995274)

	Subject	Repo	Branch	Lines +/-
	jsdoc: Support dots in '@module <name>' and '@exports <name>'	mediawiki/core	master	+53 -24

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 7 2024, 8:41 PM

Change 998364 had a related patch set uploaded (by Jdlrobson; author: Bartosz Dziewoński):

[mediawiki/core@master] jsdoc: Support dots in '@module <name>' and '@exports <name>'

Catrope closed this task as Resolved.Feb 9 2024, 10:32 PM

Catrope assigned this task to matmarex.

Change 998364 merged by jenkins-bot:

[mediawiki/core@master] jsdoc: Support dots in '@module <name>' and '@exports <name>'