showcase: ngdoc improvements
authorgustavo <gu.martinm@gmail.com>
Fri, 25 Sep 2015 22:55:25 +0000 (00:55 +0200)
committergustavo <gu.martinm@gmail.com>
Fri, 25 Sep 2015 22:55:25 +0000 (00:55 +0200)
angularjs/showcase/src/showcase/app/cars/cars.service.js

index 6b1c7cd..9a78a49 100644 (file)
@@ -38,6 +38,8 @@
      *
      * @description
      * Get cars from API REST.
+     *
+     * @returns {Promise} Promise that will be resolved or rejected when $http responds.
      */
     function getAll() {
       return $http.get(API.CARS)
      *
      * @description
      * Get one car by its id from API REST.
+     *
+     * @returns {Promise} Promise that will be resolved or rejected when $http responds.
      */
     function getById(id) {
       expectedValue = $http.get(API.CAR.replace(':carId', id));
       return expectedValue;
     }
 
+    /**
+     * @ngdoc method
+     * @name getExpectedValue
+     * @methodOf app.cars.cars
+     *
+     * @description
+     * Returns expected value as promise.
+     *
+     * @returns {Promise} Promise that will be resolved or rejected when $http responds.
+     */
     function getExpectedValue() {
       return expectedValue;
     }