как разместить контроллеры в модулях с помощью ngdoc

Я использую модуль grunt grunt-ngdocs, и это код, который создает документацию.

ngdocs: {
            all: app_files,
            scripts: ['angular.js']
        }

У меня есть модуль под названием starter и два контроллера: controllerA, controllerB

/**
  * 
  * @ngdoc object
  * @name controllerA

  * @description  ...
  */

/**
  * 
  * @ngdoc object
  * @name controllerB

  * @description  ...
  */

При запуске генератора документации эти контроллеры отображаются как модули.

Как мне написать в разметке ngdoc, что они оба подключены к пускателю модуля?

contollerA и controllerB находятся в разных файлах.


angularjs jsdoc
person David Michael Gang    schedule 07.10.2014    source источник

Ответы (1)


arrow_upward
8
arrow_downward

Обычно вы пишете ngdoc таким образом для контроллеров:

@name имя_модуля.controller:имя_контроллера

В вашем случае вы можете написать:

/**
 * @ngdoc controller
 * @name starter.controller:controllerA
 *
 * ....
*/
person DevTrong    schedule 07.10.2014
comment
Зачем нужен дополнительный .controller:? - person schmod; 12.05.2016
comment
Вы также можете написать @name moduleName.factory:factoryName для документирования фабрики. Поэтому, если вы создадите документацию, она разделит их все (служба, директива, контроллер и т. д.) - person DevTrong; 17.05.2016