ngdocs - как документировать конфигурацию модуля и запустить блок

Question

Недавно я начал использовать ngdocs в своем угловом приложении, и я озадачен тем, как правильно задокументировать конфигурацию модулей и запустить блок.

У меня есть это в настоящее время:

/**
 * @ngdoc overview
 * @name app.core
 * @description
 * # app.core
 * This module defines the core application behaviour such as routing and translation services.
 */
angular.module('app.core', ['pascalprecht.translate',
    'ui.router'
  ])
  .run(['$rootScope', '$state', 'AuthService', function($rootScope, $state, AuthService){
    //How to document this?
    $rootScope.$on('$stateChangeStart', function(event, toState, toParams){
      if(toState.name !== 'login' && !AuthService.isLoggedIn()){
        var requestedState = {
          toState: toState,
          toParams: toParams
        };
        $state.go('login', requestedState);
        event.preventDefault();
      }
    });
  }]);

Который выводит модуль app.core в документах, как и ожидалось. Но как я могу документировать блок запуска? Я изо всех сил пытаюсь найти какие-либо примеры там.

Спасибо

Answer 1

Попробуйте изменить @nameт.е.

* @name app.core.run:AuthService

PS: я охотился за лучшими типами @ngdoc. Я бы предпочел, чтобы мы могли использовать @ngdoc config или же @ngdoc run, но до сих пор я не нашел, что они являются допустимыми типами.