1
0
mirror of https://github.com/videojs/video.js.git synced 2024-12-23 02:04:34 +02:00
video.js/build/jsdoc-workarounds.js

14 lines
442 B
JavaScript

/**
* 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'
);
}
};