Integrering med autoconf
Väldigt enkelt! Bara lägg till en rad till ditt configure.ac-skript.
# check for gtk-doc GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
Detta kommer att kräva att alla utvecklare har gtk-doc installerat. Om det är okej för ditt projekt att ha ett valfritt api-dokumentation bygge, kan du lösa det enligt nedan. Behåll det som det är eftersom gtkdocize letar efter GTK_DOC_CHECK i början på en rad.
# check for gtk-doc m4_ifdef([GTK_DOC_CHECK], [ GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) ],[ AM_CONDITIONAL([ENABLE_GTK_DOC], false) ])
Det första argumentet används för att leta efter gtkdoc-versionen under konfigurationen. Det andra, valfria, argumentet används av gtkdocize. Makrot GTK_DOC_CHECK lägger också till flera configure-flaggor:
- --with-html-dir=SÖKVÄG : sökväg till installerad dokumentation
- --enable-gtk-doc : använd gtk-doc för att bygga dokumentation [standardvärde=no]
- --enable-gtk-doc-html : bygg dokumentation i html-format [standardvärde=yes]
- --enable-gtk-doc-pdf : bygg dokumentation i pdf-format [standardvärde=no]
GTK-Doc är inaktiverat som standard! Kom ihåg att skicka flaggan ”--enable-gtk-doc” vid nästa körning av configure. Annars kommer förgenererad dokumentation att installeras (vilket är rimligt för användare men inte för utvecklare).
Vidare rekommenderas det att du har följande rad i ditt configure.ac-skript. Den låter gtkdocize automatiskt kopiera makrodefinitionen för GTK_DOC_CHECK till ditt projekt.
AC_CONFIG_MACRO_DIR(m4)
Efter att alla ändringar i configure.ac är gjorda, uppdatera filen configure. Detta kan göras genom att köra om autoreconf -i eller autogen.sh.