mediawiki-extensions-Popups/jsdoc.json

{
	"opts": {
		"destination": "docs/js",
		"package": "package.json",
		"pedantic": true,
		"readme": "README.md",
		"recurse": true
	},
	"plugins": [
		"plugins/markdown"
	],
	"source": {
		"include": [ "src" ]
	},
	"templates": {
		"cleverLinks": true,
		"default": {
			"useLongnameInNav": true
		}
	}
}
doc: Replace JSDuck v5.3.4 with JSDoc v3.4.3 JSDoc can handle ES2015 modules whereas JSDuck can't. Regardless of however many features JSDuck has that JSDoc mightn't [0], we can't use JSDuck to document this codebase. [0] T138401 Bug: T158236 Change-Id: I8da712075dd28f6b228c96fa9577ca39eb148fb5 2017-05-19 11:28:35 +00:00			`{`
Doc: forbid JSDoc warnings & work around tag checker The Popups' JSDocs currently generate without any warnings. Let's keep it that way for as long as we can by enabling pedantic mode which causes a failing exit status when warnings are emitted. This behavior can be verified by adding adding `/** @ignore foo */`. The JSDoc tag checker should leverage the default enabled dictionaries but that doesn't seem to be happening[0]. For the time being, allow unknown tags so that the full range is supported, including @template, which are very useful for type checking. Minerva already allows unknown tags. Lastly, change spaces to tabs since that's what this codebase uses. [0] https://github.com/jsdoc3/jsdoc/issues/1542 Change-Id: I0aef9f7a6ca4af28d104628cda7763ec70110413 2018-06-26 15:40:32 +00:00			`"opts": {`
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For Popups, specify package.json, readme, and default template options and moved doc/ to docs/ and autogenerated JavaScript documentation from doc/autogenerated to docs/js. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: I81e64f06265f1ecc4e2ee159deef9b204ea7e957 2018-07-19 14:12:32 +00:00			`"destination": "docs/js",`
			`"package": "package.json",`
Doc: forbid JSDoc warnings & work around tag checker The Popups' JSDocs currently generate without any warnings. Let's keep it that way for as long as we can by enabling pedantic mode which causes a failing exit status when warnings are emitted. This behavior can be verified by adding adding `/** @ignore foo */`. The JSDoc tag checker should leverage the default enabled dictionaries but that doesn't seem to be happening[0]. For the time being, allow unknown tags so that the full range is supported, including @template, which are very useful for type checking. Minerva already allows unknown tags. Lastly, change spaces to tabs since that's what this codebase uses. [0] https://github.com/jsdoc3/jsdoc/issues/1542 Change-Id: I0aef9f7a6ca4af28d104628cda7763ec70110413 2018-06-26 15:40:32 +00:00			`"pedantic": true,`
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For Popups, specify package.json, readme, and default template options and moved doc/ to docs/ and autogenerated JavaScript documentation from doc/autogenerated to docs/js. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: I81e64f06265f1ecc4e2ee159deef9b204ea7e957 2018-07-19 14:12:32 +00:00			`"readme": "README.md",`
Doc: forbid JSDoc warnings & work around tag checker The Popups' JSDocs currently generate without any warnings. Let's keep it that way for as long as we can by enabling pedantic mode which causes a failing exit status when warnings are emitted. This behavior can be verified by adding adding `/** @ignore foo */`. The JSDoc tag checker should leverage the default enabled dictionaries but that doesn't seem to be happening[0]. For the time being, allow unknown tags so that the full range is supported, including @template, which are very useful for type checking. Minerva already allows unknown tags. Lastly, change spaces to tabs since that's what this codebase uses. [0] https://github.com/jsdoc3/jsdoc/issues/1542 Change-Id: I0aef9f7a6ca4af28d104628cda7763ec70110413 2018-06-26 15:40:32 +00:00			`"recurse": true`
			`},`
			`"plugins": [`
			`"plugins/markdown"`
			`],`
Hygiene: make JSDoc configs consistent Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For Popups, specify package.json, readme, and default template options and moved doc/ to docs/ and autogenerated JavaScript documentation from doc/autogenerated to docs/js. http://usejsdoc.org/about-configuring-jsdoc.html http://usejsdoc.org/about-commandline.html http://usejsdoc.org/about-configuring-default-template.html Bug: T188261 Change-Id: I81e64f06265f1ecc4e2ee159deef9b204ea7e957 2018-07-19 14:12:32 +00:00			`"source": {`
			`"include": [ "src" ]`
			`},`
			`"templates": {`
			`"cleverLinks": true,`
			`"default": {`
			`"useLongnameInNav": true`
			`}`
Doc: forbid JSDoc warnings & work around tag checker The Popups' JSDocs currently generate without any warnings. Let's keep it that way for as long as we can by enabling pedantic mode which causes a failing exit status when warnings are emitted. This behavior can be verified by adding adding `/** @ignore foo */`. The JSDoc tag checker should leverage the default enabled dictionaries but that doesn't seem to be happening[0]. For the time being, allow unknown tags so that the full range is supported, including @template, which are very useful for type checking. Minerva already allows unknown tags. Lastly, change spaces to tabs since that's what this codebase uses. [0] https://github.com/jsdoc3/jsdoc/issues/1542 Change-Id: I0aef9f7a6ca4af28d104628cda7763ec70110413 2018-06-26 15:40:32 +00:00			`}`
doc: Replace JSDuck v5.3.4 with JSDoc v3.4.3 JSDoc can handle ES2015 modules whereas JSDuck can't. Regardless of however many features JSDuck has that JSDoc mightn't [0], we can't use JSDuck to document this codebase. [0] T138401 Bug: T158236 Change-Id: I8da712075dd28f6b228c96fa9577ca39eb148fb5 2017-05-19 11:28:35 +00:00			`}`