记录虚假类。

我有一个函数,将我所有需要的 C++ 函数公开给 Lua,有各种不同的表,代表着我的“脚本 API”的不同方面。我希望使用 doxygen 使用公开这些脚本函数的 C++ 代码创建一个脚本参考。

我尝试在函数体中制作“伪”类,成功创建了一个具有给定名称的新条目,例如如果我制作一个名为“Math”的表格,其中有几个功能,则如何在这个“伪”类中也制作“伪”成员函数,我尝试简单地传入 \fn 定义该函数,但由于它们实际上不是真实的成员,因此不会显示,也就无法添加描述。在 doxygen 中如何创建这种效果,而不是手动编写每个类的逐字逐句的定义,而是将注释块视为真实的类和真实的成员?

点赞
用户856565
用户856565

听起来你想要将 Lua 代码像 C++ 一样进行文档化。也许这是可能的,但它可能会带来更多麻烦,不一定值得。

如果你想使用 doxygen 来文档化 Lua 代码,可以尝试使用 doxygen-lua

如果你的 Lua API 很小,你可以手写一个页面并在其中使用 \ref 来指向相关的 C++ 代码。(有点 hacky,但我之前做过这样的事情。)

你也可以考虑使用一些其他的文档生成器来处理 Lua API,比如 LuaDoc,或者在 lua-users wiki 的 DocumentingLuaCode 中列出的任何其他工具。

2012-12-31 21:47:14
用户1294021
用户1294021

我最终编写了一个假的 .doxy 文件,其中包含与 lua 值类似的类型名称。显然 doxygen 将记录任何类型。

2013-01-16 03:50:16