summaryrefslogtreecommitdiff
path: root/javascript/videojs/build/jsdoc-workarounds.js
diff options
context:
space:
mode:
Diffstat (limited to 'javascript/videojs/build/jsdoc-workarounds.js')
-rw-r--r--javascript/videojs/build/jsdoc-workarounds.js13
1 files changed, 13 insertions, 0 deletions
diff --git a/javascript/videojs/build/jsdoc-workarounds.js b/javascript/videojs/build/jsdoc-workarounds.js
new file mode 100644
index 0000000..4b4272b
--- /dev/null
+++ b/javascript/videojs/build/jsdoc-workarounds.js
@@ -0,0 +1,13 @@
+/**
+ * This jsdoc plugin works around some typescript-flavoured jsdoc that isn't actual jsdoc,
+ * so docs:api doesn't fail
+ */
+exports.handlers = {
+ jsdocCommentFound: event => {
+ // Special case for media-error.js
+ event.comment = (event.comment || '').replace(
+ '@typedef {{errorType: string, [key: string]: any}} ErrorMetadata',
+ '@typedef {Object} ErrorMetadata\n * @property {string} errorType Error type'
+ );
+ }
+};