开发者

How to extract documentation from vala code?

开发者 https://www.devze.com 2023-04-13 07:52 出处:网络
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 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
 * @retur开发者_JAVA技巧n I return nothing
 */

Thanks,

Damien


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.


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/vala-list@gnome.org/msg07321.html

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号