lua - 使用 LDoc 记录函数表

Question

ldoc 会很乐意记录这样的函数

--- Foo function
-- does a foo
function foo(param1, param2)
end

但是，我想做的是让它记录一个函数指针表。

例如

--- bar.lua ---
bar = {
   foo = function(a, b, c)
   end
}

return bar

--- foo.lua ---
local bar = require "bar"

fooapi {
    foo = bar.foo
}

我想用 fooapi 来记录这个，因为这是一个通过套接字导出的 API，我想隐藏它的具体实现位置。它需要与 fooapi 相关，我不想在输出中看到任何提及 bar.lua 或 bar.foo 的内容。

因此，如果我在 foo = bar.foo 行之后和 fooapi 表之前添加注释，那么生成的文档会将其列为普通表字段，而不是实际一个函数。

有没有一种方法可以覆盖此行为，以便 ldoc 生成类似 function fooapi.foo with parameters a,b,c 的输出？

我希望告诉它未显示的参数，并以某种方式覆盖它的类型，使其成为一个函数，其名称被覆盖以包含表中的嵌套，而不仅仅是一个普通的表字段？请注意，在公开的 API 中，函数的嵌套可以深入多个层次。

如果需要，我愿意重构代码。甚至切换到更不同或更灵活的工具。事实上，如果它不从 lua 代码中提取任何信息，而只是完全根据代码中的特殊注释生成代码，我并不介意。

Answer 1

使用显式标签，一切顺利!

--- Function that Foos.
-- Does the foo things of fooapi.
-- @function fooapi.foo
-- 
-- @tparam boolean a AAAAAAAAAAAAAAAAAAAAAAAAA.
-- @tparam number b bBbBbB.
-- @tparam string c Lorem ipsum sit dolor amet.