如何为 C 库(或任何绑定了 vala 的库)生成 valadoc?
How to generate the valadoc for a C library (or any library whose bindings ships with vala)?
我想为 gnome gio-2.0
库(它是 glib
的一部分)重新生成 valadoc
。
我知道完整的文档是 available online。
我希望能够在本地生成它(理想情况下无需自己重建库)。
Valadoc 能够从库编译期间创建的 gobject-introspection 文件(gir 文件)生成文档。
此文件包含所有定义和注释。
希望对我来说,a central repository is maintained by the vala team and the 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
Returns
Succeeded - 0 warning(s)
并创建一个 html 只有包名但没有 classes/methods/etc.
你能帮我正确调用valadoc吗?
note : for anyone curious about how the complete valadoc.org gets generated, the scripts and apps are available.
正如您已经完成的那样,您可以通过 --pkg gtk+-3.0
指定所需的包。为了使这些文档生成,您还必须指定 --deps
(没有任何额外参数)。
编辑:可能也很有趣:要实际包含文档字符串,您需要将 --importdir
参数设置到您的 gir 目录(大部分时间是 /usr/share/gir-1.0
)并添加例如--import=Gio-2.0
对于您需要文档字符串的每个包。如果您有已生成且保留评论的 vapi,您可能不需要这个额外的步骤。
我想为 gnome gio-2.0
库(它是 glib
的一部分)重新生成 valadoc
。
我知道完整的文档是 available online。
我希望能够在本地生成它(理想情况下无需自己重建库)。
Valadoc 能够从库编译期间创建的 gobject-introspection 文件(gir 文件)生成文档。 此文件包含所有定义和注释。
希望对我来说,a central repository is maintained by the vala team and the 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
Returns
Succeeded - 0 warning(s)
并创建一个 html 只有包名但没有 classes/methods/etc.
你能帮我正确调用valadoc吗?
note : for anyone curious about how the complete valadoc.org gets generated, the scripts and apps are available.
正如您已经完成的那样,您可以通过 --pkg gtk+-3.0
指定所需的包。为了使这些文档生成,您还必须指定 --deps
(没有任何额外参数)。
编辑:可能也很有趣:要实际包含文档字符串,您需要将 --importdir
参数设置到您的 gir 目录(大部分时间是 /usr/share/gir-1.0
)并添加例如--import=Gio-2.0
对于您需要文档字符串的每个包。如果您有已生成且保留评论的 vapi,您可能不需要这个额外的步骤。