Я недавно начал использовать ngdocs в своем угловом приложении, и я в тупике о том, как разумно документировать конфигурацию и запуск блока.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 в документации, как и ожидалось. Но как я могу документировать блок выполнения? Я изо всех сил пытаюсь найти какие-то примеры.
Благодаря