Files
shaka-player/docs/jsdoc.conf.json
T
Joey Parrish 749cf6d49c docs: Add support for documenting top-level enums (#4498)
Previously, top-level enums caused the generation of filenames like
"shaka.config.html#AutoShowText" instead of
"shaka.config.AutoShowText.html". This broke the generation of docs for
top-level enums (attached to a namespace instead of a class).

This adds support for these into our jsdoc template.

Related to PR #3421
2022-09-20 14:13:23 -07:00

39 lines
702 B
JSON

{
"tags": {
"dictionaries": [ "closure", "jsdoc" ]
},
"source": {
"include": [
"lib",
"ui",
"externs/shaka"
]
},
"templates": {
"default": {
"sortTutorialsByConfigOrder": true,
"useLongnameInNav": true,
"navOrder": [
"Tutorials",
"Classes",
"Enums",
"Interfaces",
"Events"
]
}
},
"plugins": [ "docs/jsdoc-plugin" ],
"markdown": {
"idInHeadings": true
},
"opts": {
"pedantic": true,
"private": true,
"recurse": true,
"readme": "docs/api-mainpage.md",
"tutorials": "docs/tutorials",
"template": "docs/jsdoc-template",
"destination": "docs/api"
}
}