Как использовать комментарии ngDoc для routeConfig

Question

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

Есть в любом случае я могу иметь это на уровне контроллеров, фабрики и т.д.

Могу ли я разместить его на уровне ниже:

/** 
* @ngdoc controller 
* @name shippingSolutionApp.controller:MainCtrl 
* @description 
* # MainCtrl 
* <strong>PAGE LEVEL CONTROLLER:</strong> This is a page level controller. 
* 
* This is a empty controller of shippingSolutionApp. Any business logic to initiate the app must fall here when required. 
* 
* This holds the initialization process for both the sub-child WebApps: Admin Dashboard and User Dashboard 
* @requires 
* $scope 
*/ 

Спасибо, ANKIT

Answer 1

Как о чем-то как это, чтобы вы начали?

Это не отличный ответ, потому что я не писал о том, что писать для @description, но, надеюсь, это иллюстрирует способ начать использование ngdocs для документирования чего-то о маршрутизации.

/** 
* @ngdoc overview 
* @name app.config:routes 
* @description 
* Your description here. 
*/ 
angular 
    .module('app') 
    .config(['$routeProvider', '$locationProvider', config]); 

function config ($routeProvider, $locationProvider) { 
    $routeProvider 
    .when(
     templateUrl : 'app/example.view.html', 
     controllerAs: 'example', 
     controller : 'ExampleController' 
    ) 
    .otherwise({ 
     redirectTo: '/' 
    }); 
}