将LuaDoc与.lua以外的扩展一起使用

时间:2010-09-10 15:04:05

标签: lua documentation-generation luadoc

我目前正在为新应用程序开发lua脚本,要求扩展名为xx_lua。我有luadoc正常工作.lua扩展,我知道我可以简单地将文件重命名为lua扩展名创建文档并重命名,但我个人更喜欢更优雅的解决方案。

是否可以让luadoc查看其他扩展程序。我试过打电话

luadoc_start *.xx_lua

但即使路径中有大量文件包含该扩展名,也不会产生输出。

1 个答案:

答案 0 :(得分:2)

如果修改luadoc是一个选项,那么你可以这样做。我刚刚看了3.0.1版本(编写本文的最新版本),在src / luadoc / taglet / standard.lua中有406行:

local patterns = { "%.lua$", "%.luadoc$" }

模式“%.lua”用于其他两个位置(同一文件,第316行)和src / luadoc / doclet / html.lua:53,最后一个似乎不相关。在我看来,正确的做法是为文件扩展名创建一个全局参数,并使用它而不是硬编码的“.lua”。也许你甚至可以向luadoc提交一个补丁,并在你的情况下为未来的程序员改进它:)