Choose JS documentation tool for PST

Closed, ResolvedPublic

Actions

As MediaWiki we could use JSDuck.

• https://www.mediawiki.org/wiki/Wikibase/Coding_conventions#Documentation

In T167970#3351555, @Afnecors wrote:

As MediaWiki we could use JSDuck.

• https://www.mediawiki.org/wiki/Wikibase/Coding_conventions#Documentation

It seems a good idea to comply with the coding conventions, but just to check (considering we are not using Ext JS):

Quoting the JSDuck FAQ

Q: Can I use JSDuck with non-ExtJS project?

A: [...] JSDuck will happily parse any valid JavaScript, but as its auto-detection capabilities are tuned for ExtJS, you'll probably need to document more things explicitly with @tags rather than relying on the auto-detection.

[...] If you're structuring your code in OOP-manner (like Ext JS is structured) JSDuck is probably a good fit. But when you're structuring your code in functional style (like jQuery), you might be better off with a different tool.

We don't plan to use functional style in our code right?