docs(platform): document platform.is() method

ionic-team · Sep 16, 2015 · 356fabc · 356fabc
1 parent 861297a
commit 356fabc
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/js/utils/platform.js b/js/utils/platform.js
@@ -301,7 +301,12 @@
       }
     },
 
-    // Check if the platform is the one detected by cordova
+    /**
+     * @ngdoc method
+     * @name ionic.Platform#is
+     * @param {string} Platform name.
+     * @returns {boolean} Whether the platform name provided is detected.
+     */
     is: function(type) {
       type = type.toLowerCase();
       // check if it has an array of platforms