Maniphest T188264

Add JSDoc configuration file
Closed, DuplicatePublic
Actions

Assigned To

None

Authored By

	• Niedzielski
	Feb 26 2018, 4:04 PM

Tags

Referenced Files

None

Subscribers

• Niedzielski

Description

Read http://usejsdoc.org/ and http://usejsdoc.org/about-configuring-jsdoc.html
Translate existing JSDuck configurations as wanted into new configuration files in MobileFrontend and MinervaNeue
Add temporary jsdoc script to package.json
Given a JavaScript file with a valid JSDoc commment, npm -s run jsdoc generates documentation in docs/

Tech question to answer: can / should we make a wikimedia-jsdoc-config NPM package?

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open	Feature	None	T263914 Offer TypeScript declaration files for the MediaWiki Javascript API (MediaWiki API typings)
		Resolved		hashar	T213282 JSDuck at doc.wikimedia.org loads fonts from google
		Open		None	T334853 Clean up JS code now that we can use ES6 rather than ES5 across all Wikimedia deployed codebases
		Open		None	T363905 Uninstall jsduck and related material from CI images etc., once it's no longer needed
		Open		apaskulin	T138401 Replace jsduck with JSDoc3 across all Wikimedia code bases
		Resolved		Jdlrobson	T195473 [GOAL] Invest in the MobileFrontend & MinervaNeue frontend architecture
		Resolved		Ryasmeen	T197133 Remove the WatchstarGateway cache
		Resolved		Jdlrobson	T188261 [MobileFrontend] Replace JSDuck with JSDoc
		Duplicate		None	T188262 Remove JSDuck
		Duplicate		None	T188263 Fix JSDoc offenders
		Duplicate		None	T188264 Add JSDoc configuration file

Event Timeline

• Niedzielski created this task.Feb 26 2018, 4:04 PM

• Niedzielski updated the task description. (Show Details)

Jdlrobson moved this task from Incoming to Triaged but Future on the Web-Team-Backlog board.Feb 26 2018, 4:50 PM

ovasileva triaged this task as Medium priority.Feb 28 2018, 5:45 PM

Jdlrobson closed this task as a duplicate of T188261: [MobileFrontend] Replace JSDuck with JSDoc.Feb 28 2018, 6:31 PM