【问题标题】:use LDoc to generate document for whole lua project with index page使用 LDoc 为带有索引页面的整个 lua 项目生成文档
【发布时间】:2014-07-17 16:10:29
【问题描述】:

我想为我的lua 项目生成文档 但是使用Ldoc,我会为每个lua 文件生成docs,并且每次输出文件都会覆盖index.html 文件。

所以我的问题是如何为整个项目生成生成文档,其中包含指向所有页面的链接的索引页面。

我尝试使用 see 标记来执行此操作,但我不知道是否可以使用它来引用另一个文件而不是文档中的另一个部分

我用过这个:

ldoc.lua.bat pathtomyproject/filename.lua

输出是默认路径myluainstallationpath/doc/index.html

【问题讨论】:

  • 我没有找到任何可以执行的命令,我尝试使用 powershell 脚本读取所有文件,但在 LDoc 情况下不起作用,因为它总是覆盖相同
  • ldoc.lua.bat pathtomyproject/filename.lua
  • 输出是默认路径myluainstallationpath/doc/index.html
  • 请将您的配置文件添加到您的帖子中(不要在评论中)
  • thx schollii 但我想知道是否有任何方法可以在 ldoc 中为整个项目生成文档,例如属性或我已阅读所有文档的内容,但我没有找到任何关于此的内容

标签: lua luadoc


【解决方案1】:

改用ldoc.lua.bat pathtomyproject。这将为pathtomyproject 中的所有文件生成文档,并将生成一个 index.html 链接到该文件夹​​中使用的每个文件..

【讨论】:

  • 嗯,我尝试了类似的方法,但如果我通过根目录 (see),ldoc 不会生成任何内容。知道我可能做错了什么吗?
猜你喜欢
  • 1970-01-01
  • 2019-04-07
  • 1970-01-01
  • 2014-04-10
  • 2023-03-29
  • 2021-11-17
  • 2019-02-06
  • 2019-11-17
  • 1970-01-01
相关资源
最近更新 更多