Merge pull request #3984 from whymarrh/3941-jsdoc

Add a few docblocks to background files

1 files changed, 14 insertions, 9 deletions

diff --git a/app/scripts/platforms/window.js b/app/scripts/platforms/window.js
index 1527c008b..943b2a703 100644
--- a/app/scripts/platforms/window.js
+++ b/app/scripts/platforms/window.js
@@ -1,18 +1,23 @@
-
 class WindowPlatform {
-
-  //
-  // Public
-  //
-
+  /**
+   * Reload the platform
+   */
   reload () {
-    global.location.reload()
+    /** @type {any} */ (global).location.reload()
   }
 
-  openWindow ({ url }) {
-    global.open(url, '_blank')
+  /**
+   * Opens a window
+   * @param {{url: string}} opts - The window options
+   */
+  openWindow (opts) {
+    /** @type {any} */ (global).open(opts.url, '_blank')
   }
 
+  /**
+   * Returns the platform version
+   * @returns {string}
+   */
   getVersion () {
     return '<unable to read version>'
   }