diff --git a/android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetView.java b/android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetView.java index c6db4b360c..b1a906d9ee 100644 --- a/android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetView.java +++ b/android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetView.java @@ -222,8 +222,8 @@ public class JitsiMeetView extends FrameLayout { /** * 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 - * instead. + * the specified {@code URL} is {@code null} and the Welcome page is + * enabled, the Welcome page is displayed instead. * * @param url - The {@code URL} to load which may identify a conference to * join. @@ -263,16 +263,15 @@ public class JitsiMeetView extends FrameLayout { } reactRootView = new ReactRootView(getContext()); - reactRootView - .startReactApplication(reactInstanceManager, "App", props); + reactRootView.startReactApplication(reactInstanceManager, "App", props); reactRootView.setBackgroundColor(BACKGROUND_COLOR); addView(reactRootView); } /** * Loads a specific URL {@link String} which may identify a conference to - * join. If the specified URL {@code String} is {@code null}, the Welcome - * page is displayed instead. + * join. If the specified URL {@code String} is {@code null} and the Welcome + * page is enabled, the Welcome page is displayed instead. * * @param urlString - The URL {@code String} to load which may identify a * conference to join. diff --git a/ios/app/src/ViewController.m b/ios/app/src/ViewController.m index b9eb69b69b..dd610296a3 100644 --- a/ios/app/src/ViewController.m +++ b/ios/app/src/ViewController.m @@ -32,10 +32,10 @@ JitsiMeetView *view = (JitsiMeetView *) self.view; view.delegate = self; - // As this is the Jitsi Meet app (i.e. not the Jitsi Meet SDK), we do - // want the Welcome page to be enabled. It defaults to disabled in the - // SDK at the time of this writing but it is clearer to be explicit - // about what we want anyway. + // As this is the Jitsi Meet app (i.e. not the Jitsi Meet SDK), we do want + // the Welcome page to be enabled. It defaults to disabled in the SDK at the + // time of this writing but it is clearer to be explicit about what we want + // anyway. view.welcomePageEnabled = YES; [view loadURL:nil]; } diff --git a/ios/sdk/src/JitsiMeetView.m b/ios/sdk/src/JitsiMeetView.m index e7d5e2bf2d..eed8e1681d 100644 --- a/ios/sdk/src/JitsiMeetView.m +++ b/ios/sdk/src/JitsiMeetView.m @@ -178,8 +178,8 @@ static NSMapTable *views; /** * 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 - * instead. + * the specified {@code NSURL} is {@code nil} and the Welcome page is enabled, + * the Welcome page is displayed instead. * * @param url - The {@code NSURL} to load which may identify a conference to * join. @@ -223,8 +223,8 @@ static NSMapTable *views; /** * 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 - * is displayed instead. + * join. If the specified URL {@code NSString} is {@code nil} and the Welcome + * page is enabled, the Welcome page is displayed instead. * * @param urlString - The URL {@code NSString} to load which may identify a * conference to join. diff --git a/react/features/app/components/AbstractApp.js b/react/features/app/components/AbstractApp.js index a3f302d5b4..38dd535425 100644 --- a/react/features/app/components/AbstractApp.js +++ b/react/features/app/components/AbstractApp.js @@ -13,11 +13,7 @@ import { RouteRegistry } from '../../base/react'; import { MiddlewareRegistry, ReducerRegistry } from '../../base/redux'; import { toURLString } from '../../base/util'; -import { - appNavigate, - appWillMount, - appWillUnmount -} from '../actions'; +import { appNavigate, appWillMount, appWillUnmount } from '../actions'; declare var APP: Object; @@ -34,7 +30,7 @@ const DEFAULT_URL = 'https://meet.jit.si'; */ export class AbstractApp extends Component { /** - * AbstractApp component's property types. + * {@code AbstractApp} component's property types. * * @static */ @@ -46,7 +42,7 @@ export class AbstractApp extends Component { defaultURL: React.PropTypes.string, /** - * (Optional) Redux store for this app. + * (Optional) redux store for this app. */ 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 - * the new instance is to be initialized. + * @param {Object} props - The read-only React {@code Component} props with + * which the new instance is to be initialized. */ constructor(props) { super(props); this.state = { /** - * The Route rendered by this AbstractApp. + * The Route rendered by this {@code AbstractApp}. * * @type {Route} */ route: undefined, /** - * The Redux store used by this AbstractApp. + * The redux store used by this {@code AbstractApp}. * * @type {Store} */ @@ -118,23 +114,23 @@ export class AbstractApp extends Component { } /** - * Notifies this mounted React Component that it will receive new props. - * Makes sure that this AbstractApp has a Redux store to use. + * Notifies this mounted React {@code Component} that it will receive new + * props. Makes sure that this {@code AbstractApp} has a redux store to use. * * @inheritdoc - * @param {Object} nextProps - The read-only React Component props that this - * instance will receive. + * @param {Object} nextProps - The read-only React {@code Component} props + * that this instance will receive. * @returns {void} */ 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' - // 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 // such a case this instance should create its own internal - // Redux store. If the consumer did not provide a Redux store - // before, then this instance is using its own internal Redux + // redux store. If the consumer did not provide a redux store + // before, then this instance is using its own internal redux // store already. && typeof this.props.store !== 'undefined') { this.setState({ @@ -166,15 +162,16 @@ export class AbstractApp extends Component { } /** - * Gets a Location object from the window with information about the current - * location of the document. Explicitly defined to allow extenders to - * override because React Native does not usually have a location property - * on its window unless debugging remotely in which case the browser that is - * the remote debugger will provide a location property on the window. + * Gets a {@code Location} object from the window with information about the + * current location of the document. Explicitly defined to allow extenders + * to override because React Native does not usually have a location + * property on its window unless debugging remotely in which case the + * browser that is the remote debugger will provide a location property on + * the window. * * @public - * @returns {Location} A Location object with information about the current - * location of the document. + * @returns {Location} A {@code Location} object with information about the + * current location of the document. */ getWindowLocation() { return undefined; @@ -205,14 +202,14 @@ export class AbstractApp extends Component { } /** - * Create a ReactElement from the specified component, the specified props - * and the props of this AbstractApp which are suitable for propagation to - * the children of this Component. + * Creates a {@link ReactElement} from the specified component, the + * specified props and the props of this {@code AbstractApp} which are + * suitable for propagation to the children of this {@code Component}. * - * @param {Component} component - The component from which the ReactElement - * is to be created. - * @param {Object} props - The read-only React Component props with which - * the ReactElement is to be initialized. + * @param {Component} component - The component from which the + * {@code ReactElement} is to be created. + * @param {Object} props - The read-only React {@code Component} props with + * which the {@code ReactElement} is to be initialized. * @returns {ReactElement} * @protected */ @@ -245,12 +242,12 @@ export class AbstractApp extends Component { } /** - * Initializes a new Redux store instance suitable for use by - * this AbstractApp. + * Initializes a new redux store instance suitable for use by this + * {@code AbstractApp}. * * @private - * @returns {Store} - A new Redux store instance suitable for use by - * this AbstractApp. + * @returns {Store} - A new redux store instance suitable for use by + * this {@code AbstractApp}. */ _createStore() { // 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 - * @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() { // 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 - * @returns {Store} - The Redux store used by this AbstractApp. + * @returns {Store} - The redux store used by this {@code AbstractApp}. */ _getStore() { 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 - * not defined by the consumer of this AbstractApp through its - * read-only React Component props. + * Creates a redux store to be used by this {@code AbstractApp} if such as a + * store is not defined by the consumer of this {@code AbstractApp} through + * its read-only React {@code Component} props. * - * @param {Object} props - The read-only React Component props that will - * eventually be received by this AbstractApp. + * @param {Object} props - The read-only React {@code Component} props that + * will eventually be received by this {@code AbstractApp}. * @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) { - // 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 - // dealing with Redux. If the consumer did not provide an external Redux - // store, utilize an internal Redux store. + // dealing with redux. If the consumer did not provide an external redux + // store, utilize an internal redux store. let store = props.store; 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. * @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 - * (i.e. the URL to open). + * @param {string|Object} url - The URL to navigate this {@code AbstractApp} + * to (i.e. the URL to open). * @protected * @returns {void} */ diff --git a/react/features/app/reducer.js b/react/features/app/reducer.js index a756348ab1..3e07d6d86e 100644 --- a/react/features/app/reducer.js +++ b/react/features/app/reducer.js @@ -16,8 +16,8 @@ ReducerRegistry.register('features/app', (state = {}, action) => { ...state, /** - * The one and only (i.e. singleton) App instance which is - * currently mounted. + * The one and only (i.e. singleton) {@link App} instance which + * is currently mounted. * * @type {App} */