Fix 'Missing JSDoc comment  require-jsdoc'

This commit is contained in:
Lyubo Marinov
2017-06-01 21:01:50 -05:00
parent a5d8b4a933
commit 4dc658c270
60 changed files with 60 additions and 60 deletions
+1 -1
View File
@@ -39,7 +39,7 @@ export class AbstractApp extends Component {
* The URL, if any, with which the app was launched.
*/
url: React.PropTypes.string
}
};
/**
* Initializes a new AbstractApp instance.
@@ -64,7 +64,7 @@ export default class AbstractDialog extends Component {
* the latter is unused.
*/
titleString: React.PropTypes.string
}
};
/**
* Initializes a new Dialog instance.
@@ -21,7 +21,7 @@ class Dialog extends AbstractDialog {
* I18n key to put as body title.
*/
bodyKey: React.PropTypes.string
}
};
/**
* Implements React's {@link Component#render()}.
@@ -38,7 +38,7 @@ class Dialog extends AbstractDialog {
* - string value for percentage
*/
width: React.PropTypes.string
}
};
/**
* Implements React's {@link Component#render()}.
@@ -23,7 +23,7 @@ export class DialogContainer extends Component {
* The props to pass to the component that will be rendered.
*/
_componentProps: React.PropTypes.object
}
};
/**
* Implements React's {@link Component#render()}.
@@ -27,7 +27,7 @@ export class AbstractVideoTrack extends Component {
* Video class for React Native.
*/
zOrder: React.PropTypes.number
}
};
/**
* Initializes a new AbstractVideoTrack instance.
@@ -13,7 +13,7 @@ export class Audio extends Component {
static propTypes = {
muted: React.PropTypes.bool,
stream: React.PropTypes.object
}
};
/**
* Implements React's {@link Component#render()}.
@@ -43,7 +43,7 @@ export class Video extends Component {
* 1 for the local video(s) which appear above the remote video(s).
*/
zOrder: React.PropTypes.number
}
};
/**
* React Component method that executes once component is mounted.
@@ -17,7 +17,7 @@ export default class Avatar extends Component {
*/
style: React.PropTypes.object,
uri: React.PropTypes.string
}
};
/**
* Initializes a new Avatar instance.
@@ -16,7 +16,7 @@ export default class Avatar extends Component {
* @type {string}
*/
uri: React.PropTypes.string
}
};
/**
* Implements React's {@link Component#render()}.
@@ -86,7 +86,7 @@ class ParticipantView extends Component {
* Video class for React Native.
*/
zOrder: React.PropTypes.number
}
};
/**
* Implements React's {@link Component#render()}.
@@ -39,7 +39,7 @@ export default class AbstractContainer extends Component {
* instance is to be hidden or not rendered at all.
*/
visible: React.PropTypes.bool
}
};
/**
* Renders this AbstractContainer as a React Component of a specific type.
@@ -31,7 +31,7 @@ export class Link extends Component {
* The URL to be opened when this Link is clicked/pressed.
*/
url: React.PropTypes.string
}
};
/**
* Initializes a new Link instance.
@@ -26,7 +26,7 @@ class Conference extends Component {
*/
static propTypes = {
dispatch: React.PropTypes.func
}
};
/**
* Until we don't rewrite UI using react components
@@ -73,7 +73,7 @@ class DesktopPicker extends Component {
* Used to obtain translations.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new DesktopPicker instance.
@@ -39,7 +39,7 @@ class DesktopPickerPane extends Component {
* The source type of the DesktopCapturerSources to display.
*/
type: React.PropTypes.string
}
};
/**
* Implements React's {@link Component#render()}.
@@ -35,7 +35,7 @@ class DesktopSourcePreview extends Component {
* The DesktopCapturerSource to display.
*/
source: React.PropTypes.object
}
};
/**
* Initializes a new DesktopSourcePreview instance.
@@ -16,7 +16,7 @@ class AudioInputPreview extends PureComponent {
* The JitsiLocalTrack to show an audio level meter for.
*/
track: React.PropTypes.object
}
};
/**
* Initializes a new AudioInputPreview instance.
@@ -25,7 +25,7 @@ class AudioOutputPreview extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new AudioOutputPreview instance.
@@ -102,7 +102,7 @@ class DeviceSelectionDialog extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new DeviceSelectionDialog instance.
@@ -58,7 +58,7 @@ class DeviceSelector extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new DeviceSelector instance.
@@ -32,7 +32,7 @@ class VideoInputPreview extends Component {
* The JitsiLocalTrack to display.
*/
track: React.PropTypes.object
}
};
/**
* Initializes a new VideoInputPreview instance.
@@ -19,7 +19,7 @@ class CountryIcon extends Component {
* The 2-letter country code.
*/
countryCode: React.PropTypes.string
}
};
/**
* Implements React's {@link Component#render()}.
@@ -43,7 +43,7 @@ class DialOutDialog extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new {@code DialOutNumbersForm} instance.
@@ -57,7 +57,7 @@ class DialOutNumbersForm extends Component {
* Invoked to send an ajax request for dial-out codes.
*/
updateDialOutCodes: React.PropTypes.func
}
};
/**
* Initializes a new {@code DialOutNumbersForm} instance.
@@ -37,7 +37,7 @@ class Filmstrip extends Component {
* @type {boolean}
*/
_visible: React.PropTypes.bool.isRequired
}
};
/**
* Implements React's {@link Component#render()}.
@@ -34,7 +34,7 @@ class Thumbnail extends Component {
_videoTrack: React.PropTypes.object,
dispatch: React.PropTypes.func,
participant: React.PropTypes.object
}
};
/**
* Initializes new Video Thumbnail component.
@@ -30,7 +30,7 @@ class AddPasswordForm extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new {@code AddPasswordForm} instance.
@@ -50,7 +50,7 @@ class DialInNumbersForm extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new {@code DialInNumbersForm} instance.
@@ -45,7 +45,7 @@ class InviteDialog extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Reports an analytics event for the invite modal being closed.
@@ -21,7 +21,7 @@ class LockStatePanel extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Implements React's {@link Component#render()}.
@@ -46,7 +46,7 @@ class PasswordContainer extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new {@code PasswordContainer} instance.
@@ -40,7 +40,7 @@ class RemovePasswordForm extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new {@code RemovePasswordForm} instance.
@@ -24,7 +24,7 @@ class ShareLinkForm extends Component {
* The value to be displayed and copied into the clipboard.
*/
toCopy: React.PropTypes.string
}
};
/**
* Initializes a new {@code ShareLinkForm} instance.
@@ -26,7 +26,7 @@ class LargeVideo extends Component {
* @private
*/
_participantId: React.PropTypes.string
}
};
/**
* Implements React's {@link Component#render()}.
@@ -37,7 +37,7 @@ export default class AbstractPageReloadOverlay extends Component {
* @type {string}
*/
reason: React.PropTypes.string
}
};
/**
* Initializes a new AbstractPageReloadOverlay instance.
@@ -51,7 +51,7 @@ class FilmstripOnlyOverlayFrame extends Component {
* @type {boolean}
*/
isLightOverlay: React.PropTypes.bool
}
};
/**
* Renders content related to the icon.
@@ -97,7 +97,7 @@ class OverlayContainer extends Component {
* @type {string}
*/
_suspendDetected: React.PropTypes.bool
}
};
/**
* Initializes a new ReloadTimer instance.
@@ -24,7 +24,7 @@ export default class OverlayFrame extends Component {
* @type {boolean}
*/
isLightOverlay: React.PropTypes.bool
}
};
/**
* Initializes a new AbstractOverlay instance.
@@ -26,7 +26,7 @@ class PageReloadFilmstripOnlyOverlay extends AbstractPageReloadOverlay {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Implements React's {@link Component#render()}.
@@ -26,7 +26,7 @@ class PageReloadOverlay extends AbstractPageReloadOverlay {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Implements React's {@link Component#render()}.
@@ -29,7 +29,7 @@ class ReloadButton extends Component {
* @type {string}
*/
textKey: React.PropTypes.string.isRequired
}
};
/**
* Renders the button for relaod the page if necessary.
@@ -63,7 +63,7 @@ class ReloadTimer extends Component {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new ReloadTimer instance.
@@ -23,7 +23,7 @@ class SuspendedFilmstripOnlyOverlay extends Component {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Implements React's {@link Component#render()}.
@@ -23,7 +23,7 @@ class SuspendedOverlay extends Component {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Implements React's {@link Component#render()}.
@@ -31,7 +31,7 @@ class UserMediaPermissionsFilmstripOnlyOverlay extends Component {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Implements React's {@link Component#render()}.
@@ -33,7 +33,7 @@ class UserMediaPermissionsOverlay extends Component {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new SuspendedOverlay instance.
@@ -45,7 +45,7 @@ class RemoteControlAuthorizationDialog extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new RemoteControlAuthorizationDialog instance.
@@ -22,7 +22,7 @@ class PasswordRequiredPrompt extends Component {
*/
conference: React.PropTypes.object,
dispatch: React.PropTypes.func
}
};
/**
* Initializes a new PasswordRequiredPrompt instance.
@@ -29,7 +29,7 @@ class PasswordRequiredPrompt extends Component {
conference: React.PropTypes.object,
dispatch: React.PropTypes.func,
t: React.PropTypes.func
}
};
/**
* Initializes a new PasswordRequiredPrompt instance.
@@ -22,7 +22,7 @@ class RoomLockPrompt extends Component {
*/
conference: React.PropTypes.object,
dispatch: React.PropTypes.func
}
};
/**
* Initializes a new RoomLockPrompt instance.
@@ -28,7 +28,7 @@ class SpeakerStats extends Component {
* The function to translate human-readable text.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new SpeakerStats instance.
@@ -33,7 +33,7 @@ class SpeakerStatsItem extends Component {
* True if the participant is currently the dominant speaker.
*/
isDominantSpeaker: React.PropTypes.bool
}
};
/**
* Implements React's {@link Component#render()}.
@@ -18,7 +18,7 @@ class SpeakerStatsLabels extends Component {
* The function to translate human-readable text.
*/
t: React.PropTypes.func
}
};
/**
* Implements React's {@link Component#render()}.
@@ -25,7 +25,7 @@ class TimeElapsed extends Component {
* The milliseconds to be converted into a human-readable format.
*/
time: React.PropTypes.number
}
};
/**
* Implements React's {@link Component#render()}.
@@ -40,7 +40,7 @@ export default class AbstractToolbarButton extends Component {
* The color underlaying the button.
*/
underlayColor: React.PropTypes.any
}
};
/**
* Implements React's {@link Component#render()}.
@@ -35,7 +35,7 @@ class UnsupportedDesktopBrowser extends Component {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Renders the component.
@@ -66,7 +66,7 @@ class UnsupportedMobileBrowser extends Component {
* @type {Function}
*/
t: React.PropTypes.func
}
};
/**
* Initializes the text and URL of the `Start a conference` / `Join the
@@ -54,7 +54,7 @@ export class VideoStatusLabel extends Component {
* Invoked to obtain translated strings.
*/
t: React.PropTypes.func
}
};
/**
* Initializes a new {@code VideoStatusLabel} instance.
@@ -22,7 +22,7 @@ export class AbstractWelcomePage extends Component {
_localVideoTrack: React.PropTypes.object,
_room: React.PropTypes.string,
dispatch: React.PropTypes.func
}
};
/**
* Initializes a new AbstractWelcomePage instance, including the initial