Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(jsdoc): controlText_ should have a protected access modifier. #7972

Merged
merged 1 commit into from
Oct 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/js/big-play-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ class BigPlayButton extends Button {
* The text that should display over the `BigPlayButton`s controls. Added to for localization.
*
* @type {string}
* @private
* @protected
*/
BigPlayButton.prototype.controlText_ = 'Play Video';

Expand Down
1 change: 1 addition & 0 deletions src/js/clickable-component.js
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ class ClickableComponent extends Component {

const localizedText = this.localize(text);

/** @protected */
this.controlText_ = text;
Dom.textContent(this.controlTextEl_, localizedText);
if (!this.nonIconControl && !this.player_.options_.noUITitleAttributes) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class AudioTrackButton extends TrackButton {
* The text that should display over the `AudioTrackButton`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
AudioTrackButton.prototype.controlText_ = 'Audio Track';
Component.registerComponent('AudioTrackButton', AudioTrackButton);
Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/fullscreen-toggle.js
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class FullscreenToggle extends Button {
* The text that should display over the `FullscreenToggle`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
FullscreenToggle.prototype.controlText_ = 'Fullscreen';

Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/mute-toggle.js
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ class MuteToggle extends Button {
* The text that should display over the `MuteToggle`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
MuteToggle.prototype.controlText_ = 'Mute';

Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/picture-in-picture-toggle.js
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ class PictureInPictureToggle extends Button {
* The text that should display over the `PictureInPictureToggle`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
PictureInPictureToggle.prototype.controlText_ = 'Picture-in-Picture';

Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/play-toggle.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ class PlayToggle extends Button {
* The text that should display over the `PlayToggle`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
PlayToggle.prototype.controlText_ = 'Play';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ class PlaybackRateMenuButton extends MenuButton {
* Added for localization.
*
* @type {string}
* @private
* @protected
*/
PlaybackRateMenuButton.prototype.controlText_ = 'Playback Rate';

Expand Down
7 changes: 6 additions & 1 deletion src/js/control-bar/seek-to-live.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,12 @@ class SeekToLive extends Button {
super.dispose();
}
}

/**
* The text that should display over the `SeekToLive`s control. Added for localization.
*
* @type {string}
* @protected
*/
SeekToLive.prototype.controlText_ = 'Seek to live, currently playing live';

Component.registerComponent('SeekToLive', SeekToLive);
Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/text-track-controls/captions-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ CaptionsButton.prototype.kind_ = 'captions';
* The text that should display over the `CaptionsButton`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
CaptionsButton.prototype.controlText_ = 'Captions';

Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/text-track-controls/chapters-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ ChaptersButton.prototype.kind_ = 'chapters';
* The text that should display over the `ChaptersButton`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
ChaptersButton.prototype.controlText_ = 'Chapters';

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ DescriptionsButton.prototype.kind_ = 'descriptions';
* The text that should display over the `DescriptionsButton`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
DescriptionsButton.prototype.controlText_ = 'Descriptions';

Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/text-track-controls/subs-caps-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ SubsCapsButton.prototype.kinds_ = ['captions', 'subtitles'];
*
*
* @type {string}
* @private
* @protected
*/
SubsCapsButton.prototype.controlText_ = 'Subtitles';

Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/text-track-controls/subtitles-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ SubtitlesButton.prototype.kind_ = 'subtitles';
* The text that should display over the `SubtitlesButton`s controls. Added for localization.
*
* @type {string}
* @private
* @protected
*/
SubtitlesButton.prototype.controlText_ = 'Subtitles';

Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/time-controls/current-time-display.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ CurrentTimeDisplay.prototype.labelText_ = 'Current Time';
* The text that should display over the `CurrentTimeDisplay`s controls. Added to for localization.
*
* @type {string}
* @private
* @protected
*
* @deprecated in v7; controlText_ is not used in non-active display Components
*/
Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/time-controls/duration-display.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ DurationDisplay.prototype.labelText_ = 'Duration';
* The text that should display over the `DurationDisplay`s controls. Added to for localization.
*
* @type {string}
* @private
* @protected
*
* @deprecated in v7; controlText_ is not used in non-active display Components
*/
Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/time-controls/remaining-time-display.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ RemainingTimeDisplay.prototype.labelText_ = 'Remaining Time';
* The text that should display over the `RemainingTimeDisplay`s controls. Added to for localization.
*
* @type {string}
* @private
* @protected
*
* @deprecated in v7; controlText_ is not used in non-active display Components
*/
Expand Down
2 changes: 1 addition & 1 deletion src/js/control-bar/time-controls/time-display.js
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ TimeDisplay.prototype.labelText_ = 'Time';
* The text that should display over the `TimeDisplay`s controls. Added to for localization.
*
* @type {string}
* @private
* @protected
*
* @deprecated in v7; controlText_ is not used in non-active display Components
*/
Expand Down