我有一个函数将我所有需要的 C++ 函数公开给 Lua,有各种表格代表我的“脚本 API”的不同方面,我想做的是使用 doxygen 来使用 C++ 代码进行脚本引用公开这些脚本函数。
我曾尝试在函数主体中创建“假”类,它成功地使用我给它的名称创建了一个新条目,例如,如果我创建了一个名为“Math”的表,其中有几个函数暴露在它,我如何在这个“假”类中制作“假”成员函数,我试图简单地传入\fn 定义函数,但是它没有显示,因为它们实际上不是真正的成员来添加描述.我如何在 doxygen 中创建这种效果,而不是手动修改每个类的逐字定义,而是将评论 block 视为具有真实成员的真实类?
最佳答案
听起来您正在尝试将 Lua 代码作为 C++ 来记录。也许这是可能的,但它可能比它的值(value)更麻烦。
如果你想用 doxygen 记录 Lua 代码,也许你可以试试 doxygen-lua .
如果你的 Lua API 很小,你可以手写一个页面,用\ref 指向相关的 C++ 代码。 (有点老套,但我以前做过。)
您还可以考虑为您的 Lua API 使用其他一些文档生成器,例如 LuaDoc ,或 lua-users wiki DocumentingLuaCode 上列出的任何其他内容.
关于c++ - 记录假类,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/14078027/