c17ac0cae3
This commit simplifies the exports.js plugin so it only relies on the stability notes to generate the documentation, which completely decouples it from the exportable API. As a rule of thumb, whenever something has an 'api' annotation, it should also have a 'stability' annotation. A more verbose documentation of ol3 specific annotation usage is available in the new 'apidoc/readme.md' file. This commit also modifies all source files to implement these usage suggestions.
46 lines
1.1 KiB
JSON
46 lines
1.1 KiB
JSON
{
|
|
"opts": {
|
|
"recurse": true,
|
|
"template": "apidoc/template"
|
|
},
|
|
"tags": {
|
|
"allowUnknownTags": true
|
|
},
|
|
"source": {
|
|
"includePattern": ".+\\.js(doc)?$",
|
|
"excludePattern": "(^|\\/|\\\\)_",
|
|
"exclude": [
|
|
"src/googx/dom/fullscreen.js"
|
|
],
|
|
"include": [
|
|
"src",
|
|
"externs/oli.js",
|
|
"externs/olx.js"
|
|
]
|
|
},
|
|
"plugins": [
|
|
"node_modules/jsdoc/plugins/markdown",
|
|
"apidoc/plugins/inheritdoc",
|
|
"apidoc/plugins/interface",
|
|
"apidoc/plugins/api",
|
|
"apidoc/plugins/olx-typedefs",
|
|
"apidoc/plugins/todo",
|
|
"apidoc/plugins/observable",
|
|
"apidoc/plugins/stability"
|
|
],
|
|
"markdown": {
|
|
"parser": "gfm"
|
|
},
|
|
"stability": {
|
|
"levels": ["deprecated","experimental","unstable","stable","frozen","locked"]
|
|
},
|
|
"templates": {
|
|
"cleverLinks": false,
|
|
"monospaceLinks": false,
|
|
"default": {
|
|
"outputSourceFiles": true
|
|
}
|
|
},
|
|
"jsVersion": 180
|
|
}
|