javascript - AngularJs ngdocs: メソッドが promise を返すことに注釈を付ける

Question

私は現在、grunt-ngdocs で ngdocs 構文を使用している、私の最初の実際の AngularJs アプリを文書化する過程にあります。

私のサービスメソッドがプロミスを返すことに注釈を付けるためのより良い方法があるかどうか疑問に思っていました（したがって、戻りオブジェクトにアクセスする代わりに .then() を追加する必要があることがわかります.

   * @returns {object} returns a promise

サービスの完全なコンテキスト:

/**
 * @ngdoc service
 * @name appServices.Authentication
 * @requires $http
 * @description
 * Service used to authenticate request to an api. It injects a session parameter into each request if the token parameter is set.
 * (as a request param for a GET and as an extra body param for a POST)
 **/
module.factory('Authentication', ['$http', function ($http) {

    var token;

    /**
     * @ngdoc method
     * @name appServices.Authentication#login
     * @methodOf ng.service
     * @returns {object} returns a promise
     */
    function login(email, password) {
        return $http.post('/auth/login', {email: email, password: password})
            .then(function (response) {

                if (response.data.token) {
                    token = response.data.token;
                }
            });
    }

    function getToken() {
        return token;
    }

    return {
        login: login,
        token: getToken,
    };
}]);