Как сгенерировать valadoc для библиотеки C (или любой библиотеки, привязки которой поставляются с vala)?

Я хочу заново сгенерировать valadoc для библиотеки gnome gio-2.0 (которая является частью glib).

Мне известно, что полная документация доступна в Интернете.

Я хочу иметь возможность генерировать его локально (в идеале без необходимости самостоятельно перестраивать библиотеку).

Valadoc может генерировать документацию из файла gobject-introspection (файл gir), который создается во время компиляции библиотеки. Этот файл содержит все определения и комментарии.

Надеюсь, для меня центральный репозиторий поддерживается командой vala и Gio-2.0.gir доступен.

Теперь, когда я загрузил файл, у меня возникли проблемы с вызовом valadoc с правильными параметрами.

Следующие команды:

valadoc --girdir=. --importdir=. --import=Gio-2.0 --pkg=gio-2.0 --force -o ./dist

or 

valadoc --pkg=gio-2.0 --force -o ./dist

Возвращает

Succeeded - 0 warning(s)

И создайте html только с именами пакетов, но без классов/методов/и т.д.

Не могли бы вы помочь мне правильно вызвать валадок?

примечание : для всех, кому интересно, как создается полный valadoc.org, сценарии и приложения доступны.


documentation vala gobject-introspection
person Name is carl    schedule 26.02.2015    source источник

Ответы (1)


arrow_upward
3
arrow_downward

Как вы уже делали, вы можете указать нужные пакеты, например, через --pkg gtk+-3.0. Для того, чтобы документы генерировались для них, вы также должны указать --deps (без каких-либо дополнительных аргументов).

РЕДАКТИРОВАТЬ: вероятно, это также интересно: чтобы на самом деле включить строки документов, вам нужно установить параметр --importdir в ваш каталог gir (в большинстве случаев это /usr/share/gir-1.0) и добавить, например. --import=Gio-2.0 для каждого пакета, из которого вы хотите получить строки документов. Если у вас есть сгенерированные вейпы с сохраненными комментариями, вам, вероятно, не понадобится этот дополнительный шаг.

person tom    schedule 26.02.2015