History

Add missing JSDoc of Window.interstitialModeEnabled property

David Rowe committed 8 years ago

Commit e2ae5031 parent 2fdb1141 file · +5 −2Browse files

Showing the changes to interface/src/scripting/WindowScriptingInterface.h (1 of 1 file). Show all

Unified · Split

interface/src/scripting/WindowScriptingInterface.h+5−2
@@ -41,6 +41,8 @@ · 40 unmodified lines
4141 * <em>Read-only.</em>
4242 * @property {number} y - The y display coordinate of the top left corner of the drawable area of the Interface window.
4343 * <em>Read-only.</em>
44+ * @property {boolean} interstitialModeEnabled=true - <code>true</code> if the interstitial graphics are displayed when the
45+ * domain is loading, otherwise <code>false</code>.
4446 */
4547
4648 class WindowScriptingInterface : public QObject, public Dependency {
@@ -620,9 +622,10 @@ signals: · 573 unmodified lines
620622 void redirectErrorStateChanged(bool isInErrorState);
621623
622624 /**jsdoc
623− * Triggered when interstitial mode changes.
625+ * Triggered when the interstitial mode changes.
624626 * @function Window.interstitialModeChanged
625− * @param {bool} interstitialMode - The mode of the interstitial is changed to.
627+ * @param {bool} interstitialMode - The new interstitial mode value. If <code>true</code>, the interstitial graphics are
628+ * displayed when the domain is loading.
626629 * @returns {Signal}
627630 */
628631 void interstitialModeChanged(bool interstitialMode);