Search code examples
documentation-generationvala

How to extract documentation from vala code?

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

Solution

  • 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.