Closed jboix closed 6 months ago
St.:grey_question: |
Category | Percentage | Covered / Total |
---|---|---|---|
🟢 | Statements | 98.39% (-0% 🔻) |
489/497 |
🟢 | Branches | 93.44% | 228/244 |
🟢 | Functions | 100% | 136/136 |
🟢 | Lines | 99.16% (-0% 🔻) |
473/477 |
153 tests passing in 9 suites.
Report generated by 🧪jest coverage report action from c48b0eca0fcb30650e94a0ce21ee77fb411cb2a6
:tada: This PR is included in version 1.0.0 :tada:
The release is available on:
npm package (@main dist-tag)
Your semantic-release bot :package::rocket:
Description
Resolves https://github.com/SRGSSR/pillarbox-web/issues/186 by introducing API documentation generation process:
jsdoc
generation using the jsdoc-clean-theme.src/pillarbox
,src/components/player
, andsrc/middleware/srgssr
Known Issues
article to theTutorial
section of the jsdoc for better organization.Default Options
article to theTutorial
section of the jsdoc from its previous location in the wiki.The documentation is generated alongside the demo page and deployed under
/api
.Changes made
Updated class extension for the player and enhanced documentation by adding missing
@class
annotations and included additional typedefs in typedef.js file. The added typedefs improve TypeScript type generation for various video.js components, such asAudioTrack
,TextTrack
, andVideoJsPlayer
. These changes aim to enhance code documentation and improve type support for TypeScript.