如何为 C 库（或任何绑定了 vala 的库）生成 valadoc？答案

【问题标题】：How to generate the valadoc for a C library (or any library whose bindings ships with vala)?如何为 C 库（或任何绑定了 vala 的库）生成 valadoc？
【发布时间】：2015-02-27 00:41:35
【问题描述】：

我想为 gnome gio-2.0 库（这是 glib 的一部分）重新生成 valadoc。

我知道完整的文档是available online。

我希望能够在本地生成它（最好不用自己重建库）。

Valadoc 能够从库编译期间创建的 gobject-introspection 文件（gir 文件）生成文档。此文件包含所有定义和 cmets。

希望对我来说，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 感到好奇的人。

【问题讨论】：

标签： documentation vala gobject-introspection

【解决方案1】：

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

编辑：也可能感兴趣：要实际包含文档字符串，您需要将 --importdir 参数设置到您的 gir 目录（大部分时间是 /usr/share/gir-1.0）并添加例如--import=Gio-2.0 用于您想要文档字符串的每个包。如果您的 vapis 已经生成并保留了 cmets，您可能不需要这个额外的步骤。

【讨论】：