update docs

.bithoundrc

@@ -62,6 +62,7 @@
       "mocha",
       "phantomjs-prebuilt",
       "promiscuous",
+      "remark-lint",
       "rimraf",
       "sinon",
       "sinon-chai",

README.md

@@ -108,7 +108,7 @@ See [contributing guide](.github/CONTRIBUTING.md)
 
 | Date        | Version | Description |
 | ----------- | ------- | ----------- |
-| 2016-12-20  | v1.0.24 | Maintenance |
+| 2016-12-31  | v1.0.25 | Maintenance |
 | 2016-11-23  | v1.0.19 | Use forked version of html5-desktop-notifications in order to resolve few issues |
 | 2016-11-19  | v1.0.18 | Maintenance |
 | 2016-11-04  | v1.0.16 | Upgrading to html5-desktop-notifications 3.0.0 |

angular-web-notification.js

@@ -16,7 +16,7 @@
  * @description
  * Initializes the angular web notification service.
  *
- * @param {object} NotifyLib - The HTML5 notification library instance
+ * @param {Object} NotifyLib - The HTML5 notification library instance
  */
 (function initWebNotification(NotifyLib) {
     'use strict';
@@ -28,7 +28,7 @@
      * @name webNotification
      * @namespace webNotification
      * @author Sagie Gur-Ari
-     * @returns {object} The service instance
+     * @returns {Object} The service instance
      *
      * @description
      * The web notification service wraps the HTML 5 Web Notifications API as an angular service.
@@ -62,7 +62,7 @@
              * @function
              * @memberof! webNotification
              * @private
-             * @returns {boolean} True if permission is granted, else false
+             * @returns {Boolean} True if permission is granted, else false
              */
             get: function getPermission() {
                 var permission = NotifyLib.permission;
@@ -110,7 +110,7 @@
          * @description
          * Checks if web notifications are permitted.
          *
-         * @returns {boolean} True if allowed to show web notifications
+         * @returns {Boolean} True if allowed to show web notifications
          */
         var isEnabled = function () {
             return service.permissionGranted;
@@ -126,10 +126,10 @@
          * @description
          * Displays the web notification and returning a 'hide' notification function.
          *
-         * @param {string} title - The notification title text (defaulted to empty string if null is provided)
-         * @param {object} options - Holds the notification data (web notification API spec for more info)
-         * @param {string} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico)
-         * @param {number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close)
+         * @param {String} title - The notification title text (defaulted to empty string if null is provided)
+         * @param {Object} options - Holds the notification data (web notification API spec for more info)
+         * @param {String} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico)
+         * @param {Number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close)
          * @param {function} [options.onClick] - An optional onclick event handler
          * @returns {function} The hide notification function
          */
@@ -172,8 +172,8 @@
          * @description
          * Returns an object with the show notification input.
          *
-         * @param {array} argumentsArray - An array of all arguments provided to the show notification function
-         * @returns {object} The parsed data
+         * @param {Array} argumentsArray - An array of all arguments provided to the show notification function
+         * @returns {Object} The parsed data
          */
         var parseInput = function (argumentsArray) {
             //callback is always the last argument
@@ -218,10 +218,10 @@
          * @memberof! webNotification
          * @alias webNotification.showNotification
          * @public
-         * @param {string} [title] - The notification title text (defaulted to empty string if null is provided)
-         * @param {object} [options] - Holds the notification data (web notification API spec for more info)
-         * @param {string} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico)
-         * @param {number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close)
+         * @param {String} [title] - The notification title text (defaulted to empty string if null is provided)
+         * @param {Object} [options] - Holds the notification data (web notification API spec for more info)
+         * @param {String} [options.icon=/favicon.ico] - The notification icon (defaults to the website favicon.ico)
+         * @param {Number} [options.autoClose] - Auto closes the notification after the provided amount of millies (0 or undefined for no auto close)
          * @param {function} [options.onClick] - An optional onclick event handler
          * @param {ShowNotificationCallback} [callback] - Called after the show is handled.
          * @example

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-notification",
-  "version": "1.0.24",
+  "version": "1.0.25",
   "description": "AngularJS service for displaying web notifications.",
   "authors": [
     "Sagie Gur-Ari <[email protected]>"

docs/CHANGELOG.md

@@ -1,6 +1,6 @@
 | Date        | Version | Description |
 | ----------- | ------- | ----------- |
-| 2016-12-20  | v1.0.24 | Maintenance |
+| 2016-12-31  | v1.0.25 | Maintenance |
 | 2016-11-23  | v1.0.19 | Use forked version of html5-desktop-notifications in order to resolve few issues |
 | 2016-11-19  | v1.0.18 | Maintenance |
 | 2016-11-04  | v1.0.16 | Upgrading to html5-desktop-notifications 3.0.0 |

docs/api.md

@@ -1,7 +1,7 @@
 ## Objects
 
 <dl>
-<dt><a href="#webNotification">webNotification</a> ⇒ <code>object</code></dt>
+<dt><a href="#webNotification">webNotification</a> ⇒ <code>Object</code></dt>
 <dd><p>The web notification service wraps the HTML 5 Web Notifications API as an angular service.</p>
 </dd>
 </dl>
@@ -16,15 +16,15 @@
 
 <a name="webNotification"></a>
 
-## webNotification ⇒ <code>object</code>
+## webNotification ⇒ <code>Object</code>
 The web notification service wraps the HTML 5 Web Notifications API as an angular service.
 
 **Kind**: global namespace  
-**Returns**: <code>object</code> - The service instance  
+**Returns**: <code>Object</code> - The service instance  
 **Ngdoc**: service  
 **Author:** Sagie Gur-Ari  
 
-* [webNotification](#webNotification) ⇒ <code>object</code>
+* [webNotification](#webNotification) ⇒ <code>Object</code>
     * [.allowRequest](#webNotification.allowRequest)
     * [.permissionGranted](#webNotification.permissionGranted)
     * [.showNotification([title], [options], [callback])](#webNotification.showNotification)
@@ -52,10 +52,10 @@ case of no errors) and a 'hide' function which can be used to hide the notificat
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
-| [title] | <code>string</code> |  | The notification title text (defaulted to empty string if null is provided) |
-| [options] | <code>object</code> |  | Holds the notification data (web notification API spec for more info) |
-| [options.icon] | <code>string</code> | <code>&quot;/favicon.ico&quot;</code> | The notification icon (defaults to the website favicon.ico) |
-| [options.autoClose] | <code>number</code> |  | Auto closes the notification after the provided amount of millies (0 or undefined for no auto close) |
+| [title] | <code>String</code> |  | The notification title text (defaulted to empty string if null is provided) |
+| [options] | <code>Object</code> |  | Holds the notification data (web notification API spec for more info) |
+| [options.icon] | <code>String</code> | <code>/favicon.ico</code> | The notification icon (defaults to the website favicon.ico) |
+| [options.autoClose] | <code>Number</code> |  | Auto closes the notification after the provided amount of millies (0 or undefined for no auto close) |
 | [options.onClick] | <code>function</code> |  | An optional onclick event handler |
 | [callback] | <code>[ShowNotificationCallback](#ShowNotificationCallback)</code> |  | Called after the show is handled. |
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-notification",
-  "version": "1.0.24",
+  "version": "1.0.25",
   "description": "AngularJS service for displaying web notifications.",
   "author": {
     "name": "Sagie Gur-Ari",