Integración con autoconf

Muy fácil, simplemente añada una línea a su script configure.ac.

Ejemplo 2-2Integración con autoconf
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

Esto requerirá que todos los desarrolladores tengan gtk-doc instalado. Si para su proyecto es correcto tener una configuración de construcción de api-doc opcional, puede resolver esto como sigue. Manténgalo como está, ya que gtkdocize busca en GTK_DOC_CHECK al inicio de la línea.

Ejemplo 2-3Mantener gtk-doc como opcional
# check for gtk-doc
m4_ifdef([GTK_DOC_CHECK], [
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
],[
AM_CONDITIONAL([ENABLE_GTK_DOC], false)
])

El primer argumento se usa para comprobar gtkdocversion durante la configuración. El segundo, y opcional, argumento lo usa gtkdocize. La macro GTK_DOC_CHECK también añade diversas opciones de configuración:

  1. --with-html-dir=RUTA: ruta a los documentos instalados
  2. --enable-gtk-doc: usar gtk-doc para construir la documentación [predeterminado=no]
  3. --enable-gtk-doc: usar gtk-doc para construir la documentación [predeterminado=sí]
  4. --enable-gtk-doc: usar gtk-doc para construir la documentación [predeterminado=no]

GTK-Doc está desactivado de forma predeterminada. Recuerde pasar la opción «--enable-gtk-doc» en la siguiente ejecución de configure. De otra forma, la documentación pregenerada se instala (lo que tiene sentido para usuarios, pero no para desarrolladores).

Aún más, se recomienda que tenga la siguiente línea en su script configure.ac. Esto permite que gtkdocize copie automáticamente la definición de la macro para GTK_DOC_CHECK a su proyecto.

Ejemplo 2-4Preparación para gtkdocize
AC_CONFIG_MACRO_DIR(m4)

Después de hacer los cambios en el configure.ac actualice el archivo configure. Esto se puede hacer volviendo a ejecutar autoreconf -i o autogen.sh.