Skip to content

docs: fix JSDoc documentation in external_api.js#17095

Open
codewithabhay10 wants to merge 1 commit intojitsi:masterfrom
codewithabhay10:fix/jsdoc-external-api
Open

docs: fix JSDoc documentation in external_api.js#17095
codewithabhay10 wants to merge 1 commit intojitsi:masterfrom
codewithabhay10:fix/jsdoc-external-api

Conversation

@codewithabhay10
Copy link

Fixes #17087

Changes

  • captureCameraPicture() — Fixed copy-paste bug: descriptionText and titleText param descriptions were incorrectly copied from cameraFacingMode
  • executeCommand() — Added @param {...*} args for the rest parameter and documented 20+ available commands with their arguments. Added @example block
  • setMediaEncryptionKey() — Fixed property name mismatch: keyInfo.encryptionKeykeyInfo.key to match actual code destructuring
  • getAvailableDevices() — Added resolved value shape (audioInput, audioOutput, videoInput arrays) to @returns
  • invite() — Documented invitee object properties (type, address, name) with @example

@jitsi-jenkins
Copy link

Hi, thanks for your contribution!
If you haven't already done so, could you please make sure you sign our CLA (https://jitsi.org/icla for individuals and https://jitsi.org/ccla for corporations)? We would unfortunately be unable to merge your patch unless we have that piece :(.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add comprehensive JSDoc to all public methods in external_api.js

2 participants