Описание тега ngdoc
Встроенный язык для документирования приложений angularjs
1
ответ
ngdocs - как добавить стили в демонстрационный пример
Я хотел бы добавить свои таблицы стилей CSS в демонстрационные примеры в документации по ngdocs. Я хочу, чтобы стили влияли на саму демонстрацию, но, очевидно, они не должны влиять на всю веб-страницу. Я попытался добавить свою таблицу стилей в пара…
05 ноя '15 в 06:54
1
ответ
Невозможно просмотреть описания сгенерированных документов
Хотя я могу служить из файловой системы grunt-ngdocs автоматически генерируется index.html, каждый раз, когда я пытаюсь посмотреть описание в документации, которую я получаю: XMLHttpRequest cannot load file:///C:/<file-path> Cross origin reque…
27 июл '16 в 11:00
0
ответов
gulp-ngdocs открывает изображение (или другую html-страницу) на сгенерированной веб-странице документации
Я использую gulp-ngdocs ( https://www.npmjs.com/package/gulp-ngdocs) для документирования приложения AngularJS. Я знаю, что могу добавить несколько разделов на созданную веб-страницу, но не могу связать эти разделы с другими веб-страницами. Итак, мо…
12 фев '19 в 09:24
2
ответа
ЗАОС проверяет на ngdocs?
Хотите знать, есть ли какие-либо проверки JSCS для ngdocs? В качестве альтернативы, какую инфраструктуру документации вы предлагаете для кода AngularJS и возможность проверить, хорошо ли задокументирован код? может быть связано с этим: "документальн…
17 сен '15 в 09:37
0
ответов
NGDOC - нисходящая иерархия
У меня большой проект AngularJS, который задокументирован с помощью NGDOC. У нас много форм, и конкретные директивы могут быть включены только в конкретные формы. Теперь это задокументировано как зависимости - каждая директива имеет @requires my.dir…
02 июл '15 в 12:44
1
ответ
ngDoc не может справиться с Angular styleguide
Я только что взглянул на ngDoc, и, хотя документация скудна, я понимаю, что ей нужен очень специфический синтаксис пространства имен в @name тег, например moduleName.directive:directiveName в случае директивы (почерпнул это отсюда). Тем не менее, оф…
14 июн '16 в 15:58
1
ответ
Index.html не загружается с данными после выполнения команды gulp ngdocs
Я выполнил команду gulp ngdocs и папка docs была создана в структуре папок проекта. Когда я пытаюсь запустить index.html, данные не загружаются, но когда я пытаюсь запустить один из файлов js, присутствующих в папке partials, данные Я загружаю что-т…
16 мар '16 в 15:01
0
ответов
Документирование виджетов jQuery с использованием @ngdoc
Как мне документировать виджеты jQuery, используя gulp-ngdoc? У меня есть что-то вроде этого: /** * @ngdoc widgets * @name XXX.YYY * @description * This is a jQueryUI widget to provide... * * @namespace XXX.YYY */ ... и я получаю следующую ошибку: […
14 мар '16 в 09:23
0
ответов
Как документировать свойства свойств сервисов?
Учитывая этот код: var zomg = angular.module('zomg', []); /** * @ngdoc object * @name zomg.Foo * @description * # Foo */ zomg.factory('Foo', [function () { return { /** * @ngdoc object * @name zomg.Foo.bar * @propertyOf zomg.Foo * @description * A p…
27 окт '15 в 15:56
1
ответ
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 …
29 окт '15 в 14:37
0
ответов
Пример блока ngdoc не работает, если я добавляю угловой материал в качестве зависимости
Моя основная задача ngdocs ниже. ` ngdocs: { options: { dest: 'site/docs', html5Mode: false, startPage: '/api', scripts: [ 'bower_components/angular/angular.js' 'bower_components/angular-animate/angular-animate.js', 'bower_components/angular-materia…
28 апр '16 в 21:06
0
ответов
@param {type} не отображается в Angular JSDoc
Я использую Angular JSDoc (ngDoc) для создания документа для моего углового приложения. В @param {type}Тип не отображается, и это поле пусто. Например: @param {string} name this is for usernameтип sting не отображается в выводе! В чем проблема?
07 ноя '17 в 05:47
0
ответов
Как документировать литералы объектов в AngularJS, используя ngdoc?
После 2 дней поиска я не могу понять это. Допустим, у меня есть следующий контроллер: /** * Sample Controller * * @ngdoc controller * @name module.sampleController * @requires $scope */ angular.module('module').controller('sampleController', ['$scop…
14 сен '17 в 13:07
0
ответов
Определение пользовательского типа ngdoc
Директива, которую я имею в своем проекте, становится большой с большим количеством различных опций Один из моих параметров называется tableFields у этого объекта есть много опций, которые вы можете добавить к нему: Для этого я попытался создать typ…
26 янв '17 в 13:56
2
ответа
Как описать методы углового контроллера в документации?
Я не могу описать методы контроллеров. Как я могу это сделать? /** * @ngdoc controller * @name works.controller:worksCtrl * @requires $http * @requires $element * @function * * @description * Description for works controller. All methods will be wri…
18 июл '15 в 07:54
3
ответа
Как можно использовать ngdoc для документирования объявления функции в угловом сервисе?
Я хотел бы добавить документацию ngdoc к объявлению функции в угловом сервисе. Как я могу сделать это для myFunction в примере ниже? Я считаю, что мне нужно что-то вроде @closure, @functionOf или @functionIn. Обратите внимание, что (в отличие от myM…
08 окт '15 в 11:59
0
ответов
Определите контроллер, специфичный для директивы в ngdocs
Я использую ngdocs для документирования своего приложения AngularJS. У меня есть контроллер в API, который специфичен для самой директивы. Я попытался задокументировать это как @module.directive:dirName.controller:ControllerName, но это, кажется, не…
18 дек '15 в 18:17
1
ответ
Как документировать объекты, созданные фабричной функцией, используя ngdoc в угловых?
Как использовать ngdoc для документирования "угловой фабрики", которая возвращает "фабричную функцию"? В частности, как мне документировать объекты, которые создает моя "фабричная функция"? В надуманном примере ниже я задокументировал, как использов…
12 авг '16 в 12:09
0
ответов
angular-jsdoc - Как описать трансляцию $
У меня есть сервис под названием "Утилиты". У этого сервиса есть несколько методов. Также этот сервис запускает 2 трансляции: "authUtilsFailed" и "authUtilsLoaded". Как я могу документировать эти 2 трансляции? (Используя angular-jsdoc) angular.modul…
15 дек '15 в 11:22
3
ответа
Документация ngdoc для контроллера
Я новичок в написании документации и пытаюсь задокументировать мое угловое приложение с помощью grunt-ngdocs. Я клонировал рабочий пример с: https://github.com/m7r/grunt-ngdocs-example В данном примере отсутствует документированный контроллер, поэто…
15 дек '15 в 20:43