docs($ionicPlatform): note that it returns a promise

Addresses #991
This commit is contained in:
Andy Joslin
2014-03-31 22:58:08 -06:00
parent ac94bb236e
commit 6fc3fe28b7

View File

@@ -117,6 +117,7 @@ angular.module('ionic.service.platform', [])
* Trigger a callback once the device is ready,
* or immediately if the device is already ready.
* @param {function=} callback The function to call.
* @returns {promise} A promise which is resolved when the device is ready.
*/
ready: function(cb) {
var q = $q.defer();