1

我有一个函数将我所有需要的 C++ 函数暴露给 Lua,有各种表代表我的“脚本 API”的不同方面,我想做的是使用 doxygen 使用公开这些脚本的 C++ 代码进行脚本引用职能。

我试图在函数的主体中创建“假”类,它成功地使用我给它的名称创建了一个新条目,例如,如果我创建一个名为“Math”的表,它上面有几个函数,如何我是否也会在这个“假”类中创建“假”成员函数,我试图简单地传入 \fn 定义函数,但是它没有显示出来,因为它们实际上不是要添加描述的真实成员。我如何在 doxygen 中创建这种效果,而不需要手动纠正每个类的逐字定义,而是将注释块视为具有真实成员的真实类?

4

2 回答 2

1

听起来您正试图像记录 C++ 一样记录 Lua 代码。也许这是可能的,但它可能比它的价值更麻烦。

如果您尝试使用 doxygen 记录 Lua 代码,也许您可​​以尝试doxygen-lua

如果您的 Lua API 很小,您可以手动编写一个页面,并将 \ref 用于相关的 C++ 代码。(有点hacky,但我以前做过。)

您还可以考虑为您的 Lua API 使用其他文档生成器,例如LuaDoc或 lua-users wiki DocumentingLuaCode上列出的任何其他内容。

于 2012-12-31T21:47:14.700 回答
1

我最终写了一个假的 .doxy 文件,它的类型名类似于 lua 值,显然 doxygen 会记录任何类型来扔给它。

于 2013-01-16T03:50:16.717 回答