Question

我正在尝试使用Sphinx的sphinx-js插件添加一些JavaScript代码文档。运行else { /* good value, assign to b_from_buf, output */ b_from_buf = (int)tmp; printf ("\n(a) 1st char in buffer : %c\n" "(b) int read from buffer : %d\n" "(c) remaining chars in buffer : %s\n", *buffer, b_from_buf, endptr); }时，我看到有关函数参数类型规范的警告。

我正在使用的测试JavaScript函数是：

$ ./bin/snprintf_string
A90A String

(a) 1st char in buffer        : A
(b) int read from buffer      : 90
(c) remaining chars in buffer : A String

在我的make html文件中：

/**
 * 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的文档模块，以及参数列表及其类型。但是我认为警告的出现是有原因的吗？

根据插件的usage documentation，完全支持带有或不带有类型的函数参数的“ autodoc”样式的文档。并且生成的文档似乎是完整的。这里真的有问题吗？我可以解决这些警告吗？

我正在使用：

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

功能参数类型的Sphinx-js警告

0 个答案: