如何为C库(或任何绑定vala的库)生成valadoc?

时间:2015-02-26 13:03:50

标签: documentation vala gobject-introspection

我想为gnome gio-2.0库(glib的一部分)重新生成valadoc

我知道完整的文档是available online

我希望能够在本地生成(理想情况下无需自己重建库)。

Valadoc能够从库编译期间创建的gobject-introspection文件(gir文件)生成文档。 该文件包含所有定义和注释。

希望对我来说,a central repository由vala团队维护,Gio-2.0.gir可用。

现在我下载了文件,我在使用适当的参数调用valadoc时出现问题。

以下命令:

valadoc --girdir=. --importdir=. --import=Gio-2.0 --pkg=gio-2.0 --force -o ./dist

valadoc --pkg=gio-2.0 --force -o ./dist

返回

Succeeded - 0 warning(s)

创建一个只包含包名但没有类/方法/等的HTML。

你能帮我正确调用valadoc吗?

  

注意:让所有人都对如何生成完整的valadoc.org,脚本和应用are available感到好奇。

1 个答案:

答案 0 :(得分:3)

正如您已经完成的那样,您可以通过--pkg gtk+-3.0指定所需的包。为了生成为这些文档生成的文档,您还必须指定--deps(不带任何额外的参数)。

编辑:可能也有兴趣:要实际包含文档字符串,您需要将--importdir参数设置为您的gir目录(大部分时间是/usr/share/gir-1.0)并添加例如--import=Gio-2.0。对于您想要doc字符串的每个包,{{1}}。如果您保留了已保留注释的vapis,则可能不需要执行此额外步骤。