grunt-ngdoc не отображает примеры для моей документации ngdoc

Я пытаюсь получить базовый пример работы с использованием ngDoc для моего проекта Angular.

Вот пример:

/**
 * @ngdoc directive
 * @name ui.components.uiRepeat
 * @description
 *
 * Place this attribute directive on any element that has an `ng-repeat` on it, and it will add CSS classes
 * for the different element states in the repeat set.
 *
 * @example
 <example name="uiRepeat-directive">
 <file name="index.html">
 <div ng-repeat="item in items" ui-repeat="item">
 </div>
 </file>
 </example>
 */

Когда документация скомпилирована, показывается заголовок примера, но встроенного примера нет.

Вот ссылка на скомпилированную документацию:

http://thinkingmedia.github.io/thinkingmedia-ui/

Вот ссылка на документацию Angular, показывающую, как должен выглядеть пример:

https://docs.angularjs.org/api/ng/directive/ngClick

Я не могу что не так с моим ngDoc?

1 ответ

Решение

Попробуйте заменить атрибут имени в примере тега на атрибут модуля

/**
 * @ngdoc directive
 * @name ui.components.uiRepeat
 * @description
 *
 * Place this attribute directive on any element that has an `ng-repeat` on it, and it will add CSS classes
 * for the different element states in the repeat set.
 *
 * @example
 <example module="ui">
 <file name="index.html">
 <div ng-repeat="item in items" ui-repeat="item">
 </div>
 </file>
 </example>
 */

И не забудьте добавить пути к этому модулю и директиву к вашему Gruntfile

Другие вопросы по тегам