Integração com autoconf

Muito fácil! Basta adicionar uma linha ao seu script configure.ac.

Example 2-2Integração com autoconf
# verifica por gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

Isso vai exigir que todos os desenvolvedores tenham o gtk-doc instalado. Se não houver problema para seu projeto ter uma configuração opcional de compilação de documentação de API, você pode resolver isso como mostrado abaixo. Mantenha assim, pois o gtkdocize está procurando por GTK_DOC_CHECK no começo de uma linha.

Example 2-3Mantenha o gtk-doc como opcional
# verifica por gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])

O primeiro argumento é usado para verificar a gtkdocversion em tempo de compilação. O segundo argumento é opcional, sendo usado por gtkdocize. A macro GTK_DOC_CHECK também adiciona várias opções de configuração:

  1. --with-html-dir=CAMINHO : caminho para as documentações instaladas
  2. --enable-gtk-doc : usa gtk-doc para compilar documentação [padrão=no]
  3. --enable-gtk-doc-html : compila documentação em formato html [padrão=sim]
  4. --enable-gtk-doc-pdf : compila documentação em formato pdf [padrão=não]

GTK-Doc está desabilitado por padrão! Lembre-se de passar a opção "--enable-gtk-doc" à próxima execução do configure. Do contrário, uma documentação gerada previamente é instalada (o que faz sentido para usuários, mas não para desenvolvedores).

Além disso, é recomendado que você tenha a seguinte linha dentro do seu script configure.ac. Ela permite que gtkdocize copie automaticamente a definição de macro para GTK_DOC_CHECK para o seu projeto.

Example 2-4Preparação para gtkdocize
AC_CONFIG_MACRO_DIR(m4)

Após todas as alterações do configure.ac serem feitas, atualize o arquivo configure. Isso pode ser feito executando novamente autoreconf -i ou autogen.sh.