Описание тега jsdoc2md
NoneJsdoc2md генерирует документацию по уценке из аннотированного исходного кода jsdoc. Полезно для вставки документов API в файлы README проекта.
0
ответов
Typedef не отображается в шаблоне при использовании gulp-jsdoc-to-markdown
Я пытаюсь создать автоматически сгенерированную документацию для нашего API node.js. Я использую комментарии в стиле jsDoc и gulp для запуска поколения. Я использую плагин jsdoc2md и этот плагин gulp для создания документации по стилю уценки. Я стал…
03 май '16 в 16:27
1
ответ
Пример рендеринга кода уценки со строкой (JSDoc2MD)
Я использую комментарии JSDoc в файле JS и запускаю JSDoc2MD, чтобы отобразить эти комментарии в файле readme.md уценки. Я хочу включить примеры кода в мою документацию, используя тег @example из JSDoc. У меня проблемы с отображением строки с кавычк…
12 фев '16 в 20:43
0
ответов
@param {type} не отображается в Angular JSDoc
Я использую Angular JSDoc (ngDoc) для создания документа для моего углового приложения. В @param {type}Тип не отображается, и это поле пусто. Например: @param {string} name this is for usernameтип sting не отображается в выводе! В чем проблема?
07 ноя '17 в 05:47
2
ответа
Ищите вики-документацию по API для решения на основе jsdoc
У нас есть большой кусок кода JS, документированный с помощью синтаксиса jsdoc, который мы хотели бы включить во внутреннюю вики в автоматическом режиме. Соответственно, я ищу вики-решение, способное автоматически генерировать страницы с помощью jsd…
04 апр '16 в 13:25
0
ответов
JSDoc документирование композиции объекта
Я пытаюсь выяснить, как получить документацию метода из объекта, чтобы показать внутри другого объекта. Мой код был похож на: class Main { doIt () {} doThis () {} doThat () {} } И jsdoc был великолепен! Однако я переместил вещи вокруг: class Main { …
17 окт '17 в 04:53
1
ответ
jsdoc2md: как отсортировать функцию при использовании нескольких файлов?
Я использую jsdoc2md для создания файла readme.MD на основе нескольких файлов: jsdoc2md --files a.js b.js > README.md Результат предоставляет список несортированных функций. Как получить список всех функций из всех файлов в алфавитном порядке?
08 янв '19 в 15:56
0
ответов
Как документировать массив "список параметров как" в JSDoc?
В JavaScript распространена работа с массивами, которые по сути являются списками аргументов: небольшой фиксированной длины и известными типами для каждой позиции. Это особенно верно для ECMAScript 6, который представил такие функции, как оператор о…
10 апр '15 в 12:33
0
ответов
Cordova плагин камера, предотвращающая коммит
В моем приложении Ionic есть cordova-plugin-camera@4.0.3, и он не позволяет мне работать git commit из-за ошибки при попытке создать свои собственные документы, используя jsdoc2md команда. $ git commit -m "x" > cordova-plugin-camera@4.0.3 precom…
04 окт '18 в 15:30
0
ответов
Ссылка param на внешний ресурс
Я пытаюсь связать тип параметра, используемого функцией в одном файле, с ее объявлением в другом файле. const TopBar = require('./TopBar'); const BottomTabs = require('./BottomTabs'); /** * NavigationOptions module * @module navigation-options */ /*…
10 дек '17 в 09:42
1
ответ
Как изменить цвет текста JSDoc по умолчанию?
Я использую JSDoc создать документацию для моей библиотеки JS. HTML-контент по умолчанию, сгенерированный из JSDoc, имеет текст серого цвета и его очень трудно читать. Теперь я хотел бы изменить цвет текста на черный / синий. Есть ли способ изменить…
23 май '17 в 07:24
1
ответ
Ограничения документа в JSDoc
У меня есть функция, которая является компонентом React. Создаваемый им элемент имеетposition:absolute; Чтобы это свойство работало предсказуемым образом, родительский элемент должен быть расположен с position: relatieve;. Я хотел бы сообщить будущи…
09 янв '20 в 13:00
1
ответ
JSDoc — идентификатор «info» уже объявлен
В Javascript у меня есть две функции с одинаковым именем, но с разными параметрами. Код работает правильно, но когда я пытаюсь сделать jsdoc file.jsили же jsdoc2md file.jsЯ получаю сообщение об ошибке Identifier 'info' has already been declared. Как…
28 янв '21 в 12:05
1
ответ
Добавление пользовательского содержимого в сгенерированные документы JSDoc
Мы работаем над переписыванием нашей документации по API и хотели бы добавить пользовательский контент в созданные нами документы JSDoc. Этот пользовательский контент может, например, быть запускаемыми фрагментами кода, что является функцией, котору…
02 мар '21 в 10:39
0
ответов
Изменить текст привязки в индексах элементов
Я хотел бы изменить поведение частичного по умолчанию, чтобы #anchorтекст, используемый для каждого элемента, предваряется URL-адресом. Например, по умолчанию я получаю этот список, используя {{>member-index~}}частичный: * [.deviceType](#Webex.Ap…
22 фев '22 в 17:30
0
ответов
Сгенерированный JSDoc не учитывает импортированные типы в @param
Я создаю jsdoc для библиотеки с открытым исходным кодом. Чтобы иметь более высокую согласованность, я часто импортирую наборы из *.d.tsфайл, чтобы предотвратить дублирование типов. /** * Creates the GuildChannelManager for the Guild. * @param {impor…
27 мар '22 в 19:17