记录假类

Question

我有一个将所有必需的C ++函数公开给Lua的函数，有各种表代表我的“Scripting API”的不同方面，我想做的是使用doxygen来使用C ++代码创建脚本引用公开这些脚本函数。

我试图在函数体中创建'假'类，它成功地创建了一个具有我给它的名称的新条目，例如，如果我创建一个名为'Math'的表，其中有几个函数暴露在它，我如何在这个'假'类中制作'假'成员函数，我试图简单地传递\ fn定义函数，但它没有显示，因为它们实际上不是真正的成员添加描述。我怎样才能在doxygen中创建这种效果，而无需用手调整每个类的逐字定义，而是将注释块看作是真实成员的真实类？

Answer 1

听起来你正试图将Lua代码记录为C ++。也许这是可能的，但它可能比它的价值更麻烦。

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

如果你的Lua API很小，你可以手工编写一个页面，用\ ref代替相关的C ++代码。 （有点hacky，但我以前做过这个。）

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

Answer 2

我最终编写了一个伪造的.doxy文件，其类型名称与lua值相似，显然doxygen会记录任何类型的文件。