如何从vala代码中提取文档?

发布于 2024-12-10 03:45:06 字数 222 浏览 9 评论 0原文

我想知道是否有一个工具可以从 vala 源文件中提取文档,例如 javadoc 或 doxygen 用于 Java / C++ /...

我开始记录我的代码经典的

/**
 * I'm a function !
 * @arg An argument
 * @return I return nothing
 */

谢谢,

达米安

I would like to know if there is a tool to extract documentation from vala source files like javadoc or doxygen does for Java / C++ /...

I started to document my code with classic

/**
 * I'm a function !
 * @arg An argument
 * @return I return nothing
 */

Thanks,

Damien

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

望她远 2024-12-17 03:45:06

Valadoc 就是这样做的。关于如何使用它的说明似乎有点稀疏。

另外,如果您正在编写一个同时在 Vala 和 C 中使用的库,快速测试表明 Vala 在编写 C 代码时会保留 /** 文档注释。然后,您可以使用 C 文档工具(尤其是 GTK-Doc)来生成文档。

Valadoc does this. Instructions on how to use it seem to be a bit sparse.

Also, if you are writing a library that is to be used from both Vala and C, a quick test shows that Vala preserves /** documentation comments when writing out C code. You can then use a C documentation tool, notably GTK-Doc, to generate documentation.

苍暮颜 2024-12-17 03:45:06

Valadoc 是构建文档的官方工具,但在某些系统上, make install 无法正常工作(对我来说,在 Ubuntu 11.10 下)。

因此,您必须更正某些文件的权限。

看一下这个页面: http://www.mail- archive.com/[电子邮件受保护]/msg07321.html

Valadoc is the official tool to build documentation, but on some systemes, make install don't works properly (for me, under Ubuntu 11.10).

So you have to correct the rights on some files.

Take a look at this page : http://www.mail-archive.com/[email protected]/msg07321.html

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文