Chore: Updating method decorators (#311)

box · Aug 24, 2017 · 9ae3853 · 9ae3853
1 parent 987a417
commit 9ae3853
Show file tree

Hide file tree

Showing 14 changed files with 119 additions and 8 deletions.
diff --git a/src/lib/Browser.js b/src/lib/Browser.js
@@ -278,6 +278,7 @@ class Browser {
     /**
      * Returns whether the browser is a mobile browser.
      *
+     * @public
      * @return {boolean} true if browser supports download
      */
     static isMobile() {
@@ -289,6 +290,8 @@ class Browser {
      * Returns whether the browser can download via HTML5. taken from Modernizr:
      * https://github.com/Modernizr/Modernizr/blob/master/feature-detects/a/download.js
      * Currently not supported by IE11 or Safari 10.0 http://caniuse.com/#feat=download
+     *
+     * @public
      * @return {boolean} true if browser supports download
      */
     static canDownload() {
@@ -298,6 +301,7 @@ class Browser {
     /**
      * Returns whether or not the device is running IOS
      *
+     * @public
      * @return {boolean} true if the device is running IOS
      */
     static isIOS() {
@@ -307,6 +311,7 @@ class Browser {
     /**
      * Returns whether or not the device is running Android
      *
+     * @public
      * @return {boolean} true if the device is running Android
      */
     static isAndroid() {
@@ -316,6 +321,7 @@ class Browser {
     /**
      * Returns whether or not the device is running IOS 10.3.x that has Font Ligature rendering issue.
      *
+     * @public
      * @return {boolean} Whether device is running 10.3.x
      */
     static isIOSWithFontIssue() {

diff --git a/src/lib/Cache.js b/src/lib/Cache.js
@@ -16,6 +16,7 @@ class Cache {
      * Caches a simple object in memory and in localStorage if specified.
      * Note that objects cached in localStorage will be stringified.
      *
+     * @public
      * @param {string} key - The cache key
      * @param {*} value - The cache value
      * @param {boolean} useLocalStorage - Whether or not to use localStorage
@@ -32,6 +33,7 @@ class Cache {
     /**
      * Deletes object from in-memory cache and localStorage.
      *
+     * @public
      * @param {string} key - The cache key
      * @return {void}
      */
@@ -46,6 +48,7 @@ class Cache {
     /**
      * Checks if cache has provided key.
      *
+     * @public
      * @param {string} key - The cache key
      * @return {boolean} Whether the cache has key
      */
@@ -58,8 +61,9 @@ class Cache {
      * tries to fetch from localStorage. If fetched from localStorage, object
      * will be a JSON parsed object.
      *
+     * @public
      * @param {string} key - Key of cached object
-     * @return {*} Cached object
+     * @return {Object} Cached object
      */
     get(key) {
         if (this.inCache(key)) {
@@ -87,6 +91,7 @@ class Cache {
     /**
      * Checks if memory cache has provided key.
      *
+     * @private
      * @param {string} key - The cache key
      * @return {boolean} Whether the cache has key
      */
@@ -97,6 +102,7 @@ class Cache {
     /**
      * Checks if memory cache has provided key.
      *
+     * @private
      * @param {string} key - The cache key
      * @return {boolean} Whether the cache has key
      */
@@ -117,8 +123,8 @@ class Cache {
      * localStorage was available the first time this is called, but becomes
      * unavailable at a later time.
      *
-     * @return {boolean} Whether or not localStorage is available or not.
      * @private
+     * @return {boolean} Whether or not localStorage is available or not.
      */
     localStorageAvailable() {
         if (this.available === undefined) {
@@ -139,9 +145,9 @@ class Cache {
      * Generates a key to use for localStorage from the provided key. This
      * should prevent name collisions.
      *
+     * @private
      * @param {string} key - Generate key from this key
      * @return {string} Generated key for localStorage
-     * @private
      */
     generateKey(key) {
         return `bp-${key}`;

diff --git a/src/lib/Controls.js b/src/lib/Controls.js
@@ -142,6 +142,7 @@ class Controls {
     /**
      * Handles all focusin events for the module.
      *
+     * @private
      * @param {Event} event - A DOM-normalized event object.
      * @return {void}
      */
@@ -156,6 +157,7 @@ class Controls {
     /**
      * Handles all focusout events for the module.
      *
+     * @private
      * @param {Event} event - A DOM-normalized event object.
      * @return {void}
      */
@@ -169,6 +171,7 @@ class Controls {
     /**
      * Handles click events for the control bar.
      *
+     * @private
      * @param {Event} event - A DOM-normalized event object.
      * @return {void}
      */
@@ -180,7 +183,7 @@ class Controls {
     /**
      * Adds buttons to controls
      *
-     * @private
+     * @public
      * @param {string} text - button text
      * @param {Function} handler - button handler
      * @param {string} [classList] - optional class list
@@ -216,6 +219,7 @@ class Controls {
     /**
      * Enables the controls.
      *
+     * @public
      * @return {void}
      */
     enable() {
@@ -225,6 +229,7 @@ class Controls {
     /**
      * Disables the controls.
      *
+     * @public
      * @return {void}
      */
     disable() {
@@ -234,6 +239,7 @@ class Controls {
     /**
      * Determines if the page number input is focused.
      *
+     * @public
      * @return {boolean} Is the input focused
      */
     isPageNumFocused() {

diff --git a/src/lib/Fullscreen.js b/src/lib/Fullscreen.js
@@ -81,7 +81,7 @@ class Fullscreen extends EventEmitter {
     /**
      * Toggles fullscreen mode
      *
-     * @private
+     * @public
      * @param {HTMLElement} el - fullscreen element
      * @return {void}
      */

diff --git a/src/lib/Logger.js b/src/lib/Logger.js
@@ -38,6 +38,7 @@ class Logger {
     /**
      * Gets browser capability information.
      *
+     * @private
      * @return {Object} Browser capability information
      */
     getBrowserInfo() {
@@ -61,6 +62,7 @@ class Logger {
     /**
      * Marks file as cached.
      *
+     * @public
      * @return {void}
      */
     setCached() {
@@ -70,6 +72,7 @@ class Logger {
     /**
      * Marks file as stale cache.
      *
+     * @public
      * @return {void}
      */
     setCacheStale() {
@@ -79,6 +82,7 @@ class Logger {
     /**
      * Marks file as converted.
      *
+     * @public
      * @return {void}
      */
     setUnConverted() {
@@ -89,6 +93,7 @@ class Logger {
     /**
      * Marks file as preloaded.
      *
+     * @public
      * @return {void}
      */
     setPreloaded() {
@@ -98,6 +103,7 @@ class Logger {
     /**
      * Sets the file object.
      *
+     * @public
      * @param {Object} file - file object
      * @return {void}
      */
@@ -108,6 +114,7 @@ class Logger {
     /**
      * Sets the file type.
      *
+     * @public
      * @param {string} type - content type
      * @return {void}
      */
@@ -118,6 +125,7 @@ class Logger {
     /**
      * Finishes logging.
      *
+     * @public
      * @param {Object} count - Preview count
      * @return {Object} Metrics object
      */

diff --git a/src/lib/Notification.js b/src/lib/Notification.js
@@ -39,6 +39,7 @@ class Notification {
     /**
      * Shows a notification message.
      *
+     * @public
      * @param {string} message - Notification message
      * @param {string} [buttonText] - Optional text to show in button
      * @return {void}
@@ -62,6 +63,7 @@ class Notification {
     /**
      * Hides the notification message. Does nothing if the notification is already hidden.
      *
+     * @public
      * @return {void}
      */
     hide() {
@@ -77,6 +79,7 @@ class Notification {
     /**
      * Click handler for notification.
      *
+     * @private
      * @param {Event} event - DOM event
      * @return {void}
      */

diff --git a/src/lib/Popup.js b/src/lib/Popup.js
@@ -74,6 +74,7 @@ class Popup {
     /**
      * Shows a popup with a message.
      *
+     * @public
      * @param {string} message - Popup message
      * @param {string} [buttonText] - Optional text to show in button
      * @param {Function} [buttonHandler] - Optional onclick function for the button
@@ -99,6 +100,7 @@ class Popup {
     /**
      * Hides the popup message.
      *
+     * @public
      * @return {void}
      */
     hide() {
@@ -108,6 +110,7 @@ class Popup {
     /**
      * Adds custom content to the modal.
      *
+     * @public
      * @param {string} element - DOM element
      * @param {boolean} prepend - prepends or appends the content to the content element
      *
@@ -125,6 +128,7 @@ class Popup {
     /**
      * Returns whether or not the popup is visible.
      *
+     * @public
      * @return {boolean} Whether or not popup is visible.
      */
     isVisible() {
@@ -134,6 +138,7 @@ class Popup {
     /**
      * Gets whether or not the button is disabled.
      *
+     * @public
      * @return {boolean} Whether or not button is diabled
      */
     isButtonDisabled() {
@@ -143,6 +148,7 @@ class Popup {
     /**
      * Disbles the button element.
      *
+     * @public
      * @return {void}
      */
     disableButton() {
@@ -153,6 +159,7 @@ class Popup {
     /**
      * Enables the button element.
      *
+     * @public
      * @return {void}
      */
     enableButton() {
@@ -163,6 +170,7 @@ class Popup {
     /**
      * Click handler for popup.
      *
+     * @private
      * @param {Event} event - DOM event
      * @return {void}
      */
@@ -184,6 +192,7 @@ class Popup {
     /**
      * Keydown handler for popup
      *
+     * @private
      * @param {Event} event - Keydown event
      * @return {boolean} Consumed or not
      */