Fixes jsdocs, formatting
This commit is contained in:
parent
a2c2d3bee1
commit
3546cf4915
|
@ -222,8 +222,8 @@ public class JitsiMeetView extends FrameLayout {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads a specific {@link URL} which may identify a conference to join. If
|
* Loads a specific {@link URL} which may identify a conference to join. If
|
||||||
* the specified {@code URL} is {@code null}, the Welcome page is displayed
|
* the specified {@code URL} is {@code null} and the Welcome page is
|
||||||
* instead.
|
* enabled, the Welcome page is displayed instead.
|
||||||
*
|
*
|
||||||
* @param url - The {@code URL} to load which may identify a conference to
|
* @param url - The {@code URL} to load which may identify a conference to
|
||||||
* join.
|
* join.
|
||||||
|
@ -263,16 +263,15 @@ public class JitsiMeetView extends FrameLayout {
|
||||||
}
|
}
|
||||||
|
|
||||||
reactRootView = new ReactRootView(getContext());
|
reactRootView = new ReactRootView(getContext());
|
||||||
reactRootView
|
reactRootView.startReactApplication(reactInstanceManager, "App", props);
|
||||||
.startReactApplication(reactInstanceManager, "App", props);
|
|
||||||
reactRootView.setBackgroundColor(BACKGROUND_COLOR);
|
reactRootView.setBackgroundColor(BACKGROUND_COLOR);
|
||||||
addView(reactRootView);
|
addView(reactRootView);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads a specific URL {@link String} which may identify a conference to
|
* Loads a specific URL {@link String} which may identify a conference to
|
||||||
* join. If the specified URL {@code String} is {@code null}, the Welcome
|
* join. If the specified URL {@code String} is {@code null} and the Welcome
|
||||||
* page is displayed instead.
|
* page is enabled, the Welcome page is displayed instead.
|
||||||
*
|
*
|
||||||
* @param urlString - The URL {@code String} to load which may identify a
|
* @param urlString - The URL {@code String} to load which may identify a
|
||||||
* conference to join.
|
* conference to join.
|
||||||
|
|
|
@ -32,10 +32,10 @@
|
||||||
JitsiMeetView *view = (JitsiMeetView *) self.view;
|
JitsiMeetView *view = (JitsiMeetView *) self.view;
|
||||||
|
|
||||||
view.delegate = self;
|
view.delegate = self;
|
||||||
// As this is the Jitsi Meet app (i.e. not the Jitsi Meet SDK), we do
|
// As this is the Jitsi Meet app (i.e. not the Jitsi Meet SDK), we do want
|
||||||
// want the Welcome page to be enabled. It defaults to disabled in the
|
// the Welcome page to be enabled. It defaults to disabled in the SDK at the
|
||||||
// SDK at the time of this writing but it is clearer to be explicit
|
// time of this writing but it is clearer to be explicit about what we want
|
||||||
// about what we want anyway.
|
// anyway.
|
||||||
view.welcomePageEnabled = YES;
|
view.welcomePageEnabled = YES;
|
||||||
[view loadURL:nil];
|
[view loadURL:nil];
|
||||||
}
|
}
|
||||||
|
|
|
@ -178,8 +178,8 @@ static NSMapTable<NSString *, JitsiMeetView *> *views;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads a specific {@link NSURL} which may identify a conference to join. If
|
* Loads a specific {@link NSURL} which may identify a conference to join. If
|
||||||
* the specified {@code NSURL} is {@code nil}, the Welcome page is displayed
|
* the specified {@code NSURL} is {@code nil} and the Welcome page is enabled,
|
||||||
* instead.
|
* the Welcome page is displayed instead.
|
||||||
*
|
*
|
||||||
* @param url - The {@code NSURL} to load which may identify a conference to
|
* @param url - The {@code NSURL} to load which may identify a conference to
|
||||||
* join.
|
* join.
|
||||||
|
@ -223,8 +223,8 @@ static NSMapTable<NSString *, JitsiMeetView *> *views;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Loads a specific URL {@link NSString} which may identify a conference to
|
* Loads a specific URL {@link NSString} which may identify a conference to
|
||||||
* join. If the specified URL {@code NSString} is {@code nil}, the Welcome page
|
* join. If the specified URL {@code NSString} is {@code nil} and the Welcome
|
||||||
* is displayed instead.
|
* page is enabled, the Welcome page is displayed instead.
|
||||||
*
|
*
|
||||||
* @param urlString - The URL {@code NSString} to load which may identify a
|
* @param urlString - The URL {@code NSString} to load which may identify a
|
||||||
* conference to join.
|
* conference to join.
|
||||||
|
|
|
@ -13,11 +13,7 @@ import { RouteRegistry } from '../../base/react';
|
||||||
import { MiddlewareRegistry, ReducerRegistry } from '../../base/redux';
|
import { MiddlewareRegistry, ReducerRegistry } from '../../base/redux';
|
||||||
import { toURLString } from '../../base/util';
|
import { toURLString } from '../../base/util';
|
||||||
|
|
||||||
import {
|
import { appNavigate, appWillMount, appWillUnmount } from '../actions';
|
||||||
appNavigate,
|
|
||||||
appWillMount,
|
|
||||||
appWillUnmount
|
|
||||||
} from '../actions';
|
|
||||||
|
|
||||||
declare var APP: Object;
|
declare var APP: Object;
|
||||||
|
|
||||||
|
@ -34,7 +30,7 @@ const DEFAULT_URL = 'https://meet.jit.si';
|
||||||
*/
|
*/
|
||||||
export class AbstractApp extends Component {
|
export class AbstractApp extends Component {
|
||||||
/**
|
/**
|
||||||
* AbstractApp component's property types.
|
* {@code AbstractApp} component's property types.
|
||||||
*
|
*
|
||||||
* @static
|
* @static
|
||||||
*/
|
*/
|
||||||
|
@ -46,7 +42,7 @@ export class AbstractApp extends Component {
|
||||||
defaultURL: React.PropTypes.string,
|
defaultURL: React.PropTypes.string,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* (Optional) Redux store for this app.
|
* (Optional) redux store for this app.
|
||||||
*/
|
*/
|
||||||
store: React.PropTypes.object,
|
store: React.PropTypes.object,
|
||||||
|
|
||||||
|
@ -60,24 +56,24 @@ export class AbstractApp extends Component {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initializes a new AbstractApp instance.
|
* Initializes a new {@code AbstractApp} instance.
|
||||||
*
|
*
|
||||||
* @param {Object} props - The read-only React Component props with which
|
* @param {Object} props - The read-only React {@code Component} props with
|
||||||
* the new instance is to be initialized.
|
* which the new instance is to be initialized.
|
||||||
*/
|
*/
|
||||||
constructor(props) {
|
constructor(props) {
|
||||||
super(props);
|
super(props);
|
||||||
|
|
||||||
this.state = {
|
this.state = {
|
||||||
/**
|
/**
|
||||||
* The Route rendered by this AbstractApp.
|
* The Route rendered by this {@code AbstractApp}.
|
||||||
*
|
*
|
||||||
* @type {Route}
|
* @type {Route}
|
||||||
*/
|
*/
|
||||||
route: undefined,
|
route: undefined,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The Redux store used by this AbstractApp.
|
* The redux store used by this {@code AbstractApp}.
|
||||||
*
|
*
|
||||||
* @type {Store}
|
* @type {Store}
|
||||||
*/
|
*/
|
||||||
|
@ -118,23 +114,23 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Notifies this mounted React Component that it will receive new props.
|
* Notifies this mounted React {@code Component} that it will receive new
|
||||||
* Makes sure that this AbstractApp has a Redux store to use.
|
* props. Makes sure that this {@code AbstractApp} has a redux store to use.
|
||||||
*
|
*
|
||||||
* @inheritdoc
|
* @inheritdoc
|
||||||
* @param {Object} nextProps - The read-only React Component props that this
|
* @param {Object} nextProps - The read-only React {@code Component} props
|
||||||
* instance will receive.
|
* that this instance will receive.
|
||||||
* @returns {void}
|
* @returns {void}
|
||||||
*/
|
*/
|
||||||
componentWillReceiveProps(nextProps) {
|
componentWillReceiveProps(nextProps) {
|
||||||
// The consumer of this AbstractApp did not provide a Redux store.
|
// The consumer of this AbstractApp did not provide a redux store.
|
||||||
if (typeof nextProps.store === 'undefined'
|
if (typeof nextProps.store === 'undefined'
|
||||||
|
|
||||||
// The consumer of this AbstractApp did provide a Redux store
|
// The consumer of this AbstractApp did provide a redux store
|
||||||
// before. Which means that the consumer changed their mind. In
|
// before. Which means that the consumer changed their mind. In
|
||||||
// such a case this instance should create its own internal
|
// such a case this instance should create its own internal
|
||||||
// Redux store. If the consumer did not provide a Redux store
|
// redux store. If the consumer did not provide a redux store
|
||||||
// before, then this instance is using its own internal Redux
|
// before, then this instance is using its own internal redux
|
||||||
// store already.
|
// store already.
|
||||||
&& typeof this.props.store !== 'undefined') {
|
&& typeof this.props.store !== 'undefined') {
|
||||||
this.setState({
|
this.setState({
|
||||||
|
@ -166,15 +162,16 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets a Location object from the window with information about the current
|
* Gets a {@code Location} object from the window with information about the
|
||||||
* location of the document. Explicitly defined to allow extenders to
|
* current location of the document. Explicitly defined to allow extenders
|
||||||
* override because React Native does not usually have a location property
|
* to override because React Native does not usually have a location
|
||||||
* on its window unless debugging remotely in which case the browser that is
|
* property on its window unless debugging remotely in which case the
|
||||||
* the remote debugger will provide a location property on the window.
|
* browser that is the remote debugger will provide a location property on
|
||||||
|
* the window.
|
||||||
*
|
*
|
||||||
* @public
|
* @public
|
||||||
* @returns {Location} A Location object with information about the current
|
* @returns {Location} A {@code Location} object with information about the
|
||||||
* location of the document.
|
* current location of the document.
|
||||||
*/
|
*/
|
||||||
getWindowLocation() {
|
getWindowLocation() {
|
||||||
return undefined;
|
return undefined;
|
||||||
|
@ -205,14 +202,14 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a ReactElement from the specified component, the specified props
|
* Creates a {@link ReactElement} from the specified component, the
|
||||||
* and the props of this AbstractApp which are suitable for propagation to
|
* specified props and the props of this {@code AbstractApp} which are
|
||||||
* the children of this Component.
|
* suitable for propagation to the children of this {@code Component}.
|
||||||
*
|
*
|
||||||
* @param {Component} component - The component from which the ReactElement
|
* @param {Component} component - The component from which the
|
||||||
* is to be created.
|
* {@code ReactElement} is to be created.
|
||||||
* @param {Object} props - The read-only React Component props with which
|
* @param {Object} props - The read-only React {@code Component} props with
|
||||||
* the ReactElement is to be initialized.
|
* which the {@code ReactElement} is to be initialized.
|
||||||
* @returns {ReactElement}
|
* @returns {ReactElement}
|
||||||
* @protected
|
* @protected
|
||||||
*/
|
*/
|
||||||
|
@ -245,12 +242,12 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Initializes a new Redux store instance suitable for use by
|
* Initializes a new redux store instance suitable for use by this
|
||||||
* this AbstractApp.
|
* {@code AbstractApp}.
|
||||||
*
|
*
|
||||||
* @private
|
* @private
|
||||||
* @returns {Store} - A new Redux store instance suitable for use by
|
* @returns {Store} - A new redux store instance suitable for use by
|
||||||
* this AbstractApp.
|
* this {@code AbstractApp}.
|
||||||
*/
|
*/
|
||||||
_createStore() {
|
_createStore() {
|
||||||
// Create combined reducer from all reducers in ReducerRegistry.
|
// Create combined reducer from all reducers in ReducerRegistry.
|
||||||
|
@ -275,10 +272,11 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the default URL to be opened when this App mounts.
|
* Gets the default URL to be opened when this {@code App} mounts.
|
||||||
*
|
*
|
||||||
* @protected
|
* @protected
|
||||||
* @returns {string} The default URL to be opened when this App mounts.
|
* @returns {string} The default URL to be opened when this {@code App}
|
||||||
|
* mounts.
|
||||||
*/
|
*/
|
||||||
_getDefaultURL() {
|
_getDefaultURL() {
|
||||||
// If the execution environment provides a Location abstraction, then
|
// If the execution environment provides a Location abstraction, then
|
||||||
|
@ -298,10 +296,10 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the Redux store used by this AbstractApp.
|
* Gets the redux store used by this {@code AbstractApp}.
|
||||||
*
|
*
|
||||||
* @protected
|
* @protected
|
||||||
* @returns {Store} - The Redux store used by this AbstractApp.
|
* @returns {Store} - The redux store used by this {@code AbstractApp}.
|
||||||
*/
|
*/
|
||||||
_getStore() {
|
_getStore() {
|
||||||
let store = this.state.store;
|
let store = this.state.store;
|
||||||
|
@ -314,20 +312,21 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a Redux store to be used by this AbstractApp if such as store is
|
* Creates a redux store to be used by this {@code AbstractApp} if such as a
|
||||||
* not defined by the consumer of this AbstractApp through its
|
* store is not defined by the consumer of this {@code AbstractApp} through
|
||||||
* read-only React Component props.
|
* its read-only React {@code Component} props.
|
||||||
*
|
*
|
||||||
* @param {Object} props - The read-only React Component props that will
|
* @param {Object} props - The read-only React {@code Component} props that
|
||||||
* eventually be received by this AbstractApp.
|
* will eventually be received by this {@code AbstractApp}.
|
||||||
* @private
|
* @private
|
||||||
* @returns {Store} - The Redux store to be used by this AbstractApp.
|
* @returns {Store} - The redux store to be used by this
|
||||||
|
* {@code AbstractApp}.
|
||||||
*/
|
*/
|
||||||
_maybeCreateStore(props) {
|
_maybeCreateStore(props) {
|
||||||
// The application Jitsi Meet is architected with Redux. However, I do
|
// The application Jitsi Meet is architected with redux. However, I do
|
||||||
// not want consumers of the App React Component to be forced into
|
// not want consumers of the App React Component to be forced into
|
||||||
// dealing with Redux. If the consumer did not provide an external Redux
|
// dealing with redux. If the consumer did not provide an external redux
|
||||||
// store, utilize an internal Redux store.
|
// store, utilize an internal redux store.
|
||||||
let store = props.store;
|
let store = props.store;
|
||||||
|
|
||||||
if (typeof store === 'undefined') {
|
if (typeof store === 'undefined') {
|
||||||
|
@ -380,7 +379,7 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Notifies this App that a specific Route is about to be rendered.
|
* Notifies this {@code App} that a specific Route is about to be rendered.
|
||||||
*
|
*
|
||||||
* @param {Route} route - The Route that is about to be rendered.
|
* @param {Route} route - The Route that is about to be rendered.
|
||||||
* @private
|
* @private
|
||||||
|
@ -394,10 +393,10 @@ export class AbstractApp extends Component {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Navigates this AbstractApp to (i.e. opens) a specific URL.
|
* Navigates this {@code AbstractApp} to (i.e. opens) a specific URL.
|
||||||
*
|
*
|
||||||
* @param {string|Object} url - The URL to navigate this AbstractApp to
|
* @param {string|Object} url - The URL to navigate this {@code AbstractApp}
|
||||||
* (i.e. the URL to open).
|
* to (i.e. the URL to open).
|
||||||
* @protected
|
* @protected
|
||||||
* @returns {void}
|
* @returns {void}
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -16,8 +16,8 @@ ReducerRegistry.register('features/app', (state = {}, action) => {
|
||||||
...state,
|
...state,
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The one and only (i.e. singleton) App instance which is
|
* The one and only (i.e. singleton) {@link App} instance which
|
||||||
* currently mounted.
|
* is currently mounted.
|
||||||
*
|
*
|
||||||
* @type {App}
|
* @type {App}
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue