Wordpress/jsdoc.conf.json
Anton Timmermans 53f1c74e1c Docs: Improve wp-admin JSDoc structural data globally.
JSDoc takes it structural data from `@namespace`, `@lends` and `@memberOf`. This change fixes these tags for all JavaScript files in the wp-admin folder.

* Add jsdoc configuration to parse wp-admin/js files. Use `jsdoc -c jsdoc.conf.json` to generate JSDoc.
* Define all used namespaces using `@namespace`.
* Define each usage of the extend function as a prototype assignment using `@lends`.
* Add `@alias` if JSDoc cannot detect the correct name automatically.

This has previously been corrected for all `wp-includes` JavaScript files: [41351].

Props herregroen.
Fixes #42485.


git-svn-id: https://develop.svn.wordpress.org/trunk@42403 602fd350-edb4-49c9-b593-d223f7449a82
2017-12-15 13:41:56 +00:00

51 lines
1.3 KiB
JSON

{
"plugins": [],
"recurseDepth": 10,
"source": {
"include": [
"src/wp-includes/js",
"src/wp-admin/js"
],
"exclude": [
"src/wp-includes/js/codemirror",
"src/wp-includes/js/tinymce",
"src/wp-includes/js/crop",
"src/wp-includes/js/imgareaselect",
"src/wp-includes/js/jcrop",
"src/wp-includes/js/jquery",
"src/wp-includes/js/mediaelement/mediaelement.js",
"src/wp-includes/js/mediaelement/mediaelement-and-player.js",
"src/wp-includes/js/plupload/handlers.js",
"src/wp-includes/js/plupload/moxie.js",
"src/wp-includes/js/plupload/plupload.full.min.js",
"src/wp-includes/js/plupload/plupload.js",
"src/wp-includes/js/swfupload",
"src/wp-includes/js/thickbox",
"src/wp-includes/js/media-audiovideo.js",
"src/wp-includes/js/media-grid.js",
"src/wp-includes/js/media-models.js",
"src/wp-includes/js/media-views.js"
],
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false,
"theme": "united",
"outputSourceFiles": true,
"outputSourcePath": true,
"linenums": true
},
"opts": {
"template": "./node_modules/ink-docstrap/template",
"recurse": true,
"private": true
}
}