From 3e3acee4f6bb04d8ebead1ed8476cc9461da5e04 Mon Sep 17 00:00:00 2001
From: Richard Davey <rich@photonstorm.com>
Date: Tue, 29 Jan 2019 17:17:26 +0000
Subject: [PATCH] jsdoc fixes

---
 src/scale/ScaleManager.js | 11 ++++++++---
 src/scale/const.js        |  8 ++++++--
 src/scale/index.js        |  4 ++--
 3 files changed, 16 insertions(+), 7 deletions(-)

diff --git a/src/scale/ScaleManager.js b/src/scale/ScaleManager.js
index bbec3a3dd..85e338055 100644
--- a/src/scale/ScaleManager.js
+++ b/src/scale/ScaleManager.js
@@ -138,7 +138,7 @@ var ScaleManager = new Class({
          * The game scale mode.
          *
          * @name Phaser.DOM.ScaleManager#scaleMode
-         * @type {integer}
+         * @type {Phaser.Scale.ScaleModes}
          * @since 3.16.0
          */
         this.scaleMode = CONST.NONE;
@@ -157,7 +157,12 @@ var ScaleManager = new Class({
         /**
          * The game zoom factor.
          * 
-         * This allows you to set a base size that is a multiple of your game size, before any scaling takes place.
+         * This value allows you to multiply your games base size by the given zoom factor.
+         * This is then used when calculating the display size, even in `NO_SCALE` situations.
+         * If you don't want Phaser to touch the canvas style at all, this value should be 1.
+         * 
+         * Can also be set to `MAX_ZOOM` in which case the zoom value will be derived based
+         * on the game size and available space within the parent.
          *
          * @name Phaser.DOM.ScaleManager#zoom
          * @type {number}
@@ -202,7 +207,7 @@ var ScaleManager = new Class({
         /**
          * The current device orientation.
          * 
-         * Orientation events are dispatched via the Device Orientation API and typically only on mobile browsers.
+         * Orientation events are dispatched via the Device Orientation API, typically only on mobile browsers.
          *
          * @name Phaser.DOM.ScaleManager#orientation
          * @type {string}
diff --git a/src/scale/const.js b/src/scale/const.js
index 280cbd298..7c40b87f0 100644
--- a/src/scale/const.js
+++ b/src/scale/const.js
@@ -5,9 +5,13 @@
  */
 
 /**
- * Global consts.
+ * Phaser Scale Manager constants.
  * 
- * @ignore
+ * @name Phaser.Scale.ScaleModes
+ * @enum {integer}
+ * @memberof Phaser
+ * @readonly
+ * @since 3.16.0
  */
 
 module.exports = {
diff --git a/src/scale/index.js b/src/scale/index.js
index 754b89cd7..7e6ec4ec3 100644
--- a/src/scale/index.js
+++ b/src/scale/index.js
@@ -5,7 +5,7 @@
  */
 
 var Extend = require('../utils/object/Extend');
-var CONST = require('./const');
+var ScaleModes = require('./const');
 
 /**
  * @namespace Phaser.Scale
@@ -17,6 +17,6 @@ var Scale = {
 
 };
 
-Scale = Extend(false, Scale, CONST);
+Scale = Extend(false, Scale, ScaleModes);
 
 module.exports = Scale;