Skip to content

chore: add @deprecated JSDoc annotations to legacy config options#16912

Open
dhiraj-143r wants to merge 1 commit intojitsi:masterfrom
dhiraj-143r:fix/add-deprecated-jsdoc-annotations-16911
Open

chore: add @deprecated JSDoc annotations to legacy config options#16912
dhiraj-143r wants to merge 1 commit intojitsi:masterfrom
dhiraj-143r:fix/add-deprecated-jsdoc-annotations-16911

Conversation

@dhiraj-143r
Copy link

Added @deprecated JSDoc annotations to 20 deprecated configuration options in configType.ts to improve developer experience and IDE tooling support. Each annotation references the recommended replacement option.

Fixes #16911

Added @deprecated JSDoc annotations to 20 deprecated configuration
options in configType.ts to improve developer experience and IDE
tooling support. Each annotation references the recommended
replacement option.

Deprecated options annotated:
- autoCaptionOnRecord -> transcription.autoTranscribeOnRecord
- autoKnockLobby -> lobby.autoKnock
- disableDeepLinking -> deeplinking.disabled
- disableIncomingMessageSound -> disabledSounds
- disableJoinLeaveSounds -> disabledSounds
- disableRecordAudioNotification -> disabledSounds
- disableRemoveRaisedHandOnFocus -> raisedHands.disableRemoveRaisedHandOnFocus
- disableSpeakerStatsSearch -> speakerStats.disableSearch
- enableLobbyChat -> lobby.enableChat
- enableWelcomePage -> welcomePage.disabled
- fileRecordingsServiceEnabled -> recordingService.enabled
- fileRecordingsServiceSharingEnabled -> recordingService.sharingEnabled
- gravatarBaseURL -> gravatar.baseUrl
- hideAddRoomButton -> breakoutRooms.hideAddRoomButton
- hideLobbyButton -> securityUi.hideLobbyButton
- liveStreamingEnabled -> liveStreaming.enabled
- preferredTranscribeLanguage -> transcription.preferredLanguage
- speakerStatsOrder -> speakerStats.order
- transcribeWithAppLanguage -> transcription.useAppLanguage
- transcribingEnabled -> transcription.enabled

Fixes jitsi#16911
@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 :(.

@dhiraj-143r
Copy link
Author

Thanks ,
I am already done with CLA sign

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 @deprecated JSDoc annotations to legacy configuration options

4 participants