Как извлечь документацию из кода Vala?

Question

Я хотел бы знать, есть ли инструмент для извлечения документации из исходных файлов vala, например, javadoc или doxygen делает для Java / C ++ /...

Я начал документировать свой код склассика

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

Спасибо,

Дэмиен

Answer 1

Valadoc делает это. Инструкции по его применению кажутся немного скудными.

Кроме того, если вы пишете библиотеку, которая будет использоваться как в Vala, так и в C, быстрый тест показывает, что Vala сохраняет /** комментариев к документации при написании кода C. Затем вы можете использовать инструмент документации C, в частности GTK-Doc , для генерации документации.

Answer 2

Valadoc является официальным инструментом для создания документации, но в некоторых системах make install не работает должным образом (для меня в Ubuntu 11.10).

Так что вам нужно исправить права на некоторые файлы.

Посмотрите на эту страницу: http://www.mail-archive.com/vala-list@gnome.org/msg07321.html