diff options
| author | Andrej Mihajlov <and@codeispoetry.ru> | 2017-03-17 11:27:37 +0000 |
|---|---|---|
| committer | Andrej Mihajlov <and@codeispoetry.ru> | 2017-03-17 11:27:37 +0000 |
| commit | 64004b4b983b5c93523be99785a0cb45dbab8f78 (patch) | |
| tree | e368dfd32b338afc08baa454ef086d1a734aff73 | |
| parent | 6b1693e18db3179164918f1ea4138b347f340180 (diff) | |
| download | mullvadvpn-64004b4b983b5c93523be99785a0cb45dbab8f78.tar.xz mullvadvpn-64004b4b983b5c93523be99785a0cb45dbab8f78.zip | |
Improve documentation
| -rw-r--r-- | app/lib/tray-animation.js | 22 | ||||
| -rw-r--r-- | app/lib/tray-animator.js | 2 | ||||
| -rw-r--r-- | app/lib/tray-icon-manager.js | 2 |
3 files changed, 15 insertions, 11 deletions
diff --git a/app/lib/tray-animation.js b/app/lib/tray-animation.js index 7db7a8c8ab..c5fa35f8fc 100644 --- a/app/lib/tray-animation.js +++ b/app/lib/tray-animation.js @@ -12,6 +12,7 @@ export default class TrayAnimation { /** * Set animation pace per frame in ms * + * @type {number} * @memberOf TrayAnimation */ set speed(v) { this._speed = parseInt(v); } @@ -20,13 +21,15 @@ export default class TrayAnimation { * Get animation pace per frame in ms * * @readonly - * + * @type {number} * @memberOf TrayAnimation */ get speed() { return this._speed; } /** * Set animation repetition + * @type {bool} + * * @memberOf TrayAnimation */ set repeat(v) { this._repeat = !!v; } @@ -35,13 +38,14 @@ export default class TrayAnimation { * Get animation repetition * * @readonly - * + * @type {bool} * @memberOf TrayAnimation */ get repeat() { return this._repeat; } /** * Set animation reversal + * @type {bool} * @memberOf TrayAnimation */ set reverse(v) { this._reverse = !!v; } @@ -50,14 +54,14 @@ export default class TrayAnimation { * Get animation reversal * * @readonly - * + * @type {bool} * @memberOf TrayAnimation */ get reverse() { return this._repeat; } /** * Set animation alternation - * + * @type {bool} * @memberOf TrayAnimation */ set alternate(v) { this._alternate = !!v; } @@ -66,7 +70,7 @@ export default class TrayAnimation { * Get animation alternation * * @readonly - * + * @type {bool} * @memberOf TrayAnimation */ get alternate() { return this._alternate; } @@ -75,7 +79,7 @@ export default class TrayAnimation { * Source array of images * * @readonly - * + * @type {array} * @memberOf TrayAnimation */ get source() { return this._source.slice(); } @@ -84,7 +88,7 @@ export default class TrayAnimation { * Array of NativeImage instances loaded based on source input * * @readonly - * + * @type {Electron.NativeImage[]} * @memberOf TrayAnimation */ get nativeImages() { return this._nativeImages.slice(); } @@ -93,7 +97,7 @@ export default class TrayAnimation { * Flag that tells whether animation finished * * @readonly - * + * @type {bool} * @memberOf TrayAnimation */ get isFinished() { return this._isFinished; } @@ -152,7 +156,7 @@ export default class TrayAnimation { * Get current sprite * * @readonly - * + * @type {Electron.NativeImage} * @memberOf TrayAnimation */ get currentImage() { diff --git a/app/lib/tray-animator.js b/app/lib/tray-animator.js index 2c45dce37c..d1873025f8 100644 --- a/app/lib/tray-animator.js +++ b/app/lib/tray-animator.js @@ -15,7 +15,7 @@ export default class TrayAnimator { /** * Creates an instance of TrayAnimator. - * @param {electron.Tray} tray - an instance of Tray + * @param {Electron.Tray} tray - an instance of Tray * @param {TrayAnimation} animation - an instance of TrayAnimation * * @memberOf TrayAnimator diff --git a/app/lib/tray-icon-manager.js b/app/lib/tray-icon-manager.js index 8decdba74b..3e25c6cf85 100644 --- a/app/lib/tray-icon-manager.js +++ b/app/lib/tray-icon-manager.js @@ -13,7 +13,7 @@ export default class TrayIconManager { /** * Creates an instance of TrayIconManager. - * @param {electron.Tray} tray + * @param {Electron.Tray} tray * @param {TrayIconProvider} iconProvider * * @memberOf TrayIconManager |
