Sphinx-JS предупреждения для типов параметров функций - PullRequest
Новая
       14

Sphinx-JS предупреждения для типов параметров функций

0 голосов
/ 09 января 2019

Я пытаюсь добавить документацию кода JavaScript с помощью плагина sphinx-js для Sphinx. При работе make html я вижу предупреждения относительно спецификаций типа для параметров функции.

Используемая мной тестовая функция JavaScript: 

/**
 * This is a description.
 * @param {String} first This is the first parameter.
 * @param {Number} second This is the second parameter.
 */
function testFunction(first, second) {}

И в моем .rst файле: 

.. js:autofunction:: testFunction

Это генерирует следующие предупреждения: 

util.js:testFunction(6):24: WARNING: js:func reference target not found: String
util.js:testFunction(6):24: WARNING: js:func reference target not found: Number

Должен заметить, что документация генерируется просто отлично. Включен блок документации для testFunction, а также список параметров и их типы. Но я предполагаю, что предупреждения есть по причине?

Согласно документации по использованию плагина , документация параметров функций в стиле "autodoc" - с типами или без них - полностью поддерживается. И сгенерированная документация кажется полной. Есть ли на самом деле проблема здесь? Могу ли я разрешить эти предупреждения?

Я использую: 

sphinx 1.8.3
sphinx-js 2.7.1
jsdoc 3.5.5
...