Integration in autoconf
Sehr einfach! Fügen Sie eine Zeile zu Ihrem configure.ac-Skript hinzu.
# check for gtk-doc GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
Dazu müssen alle Entwickler gtk-doc installiert haben. Wenn es für das Projekt vertretbar ist, einen optionalen Erstellungsschritt für die api-doc zu haben, so können Sie es wie im Folgenden lösen. Lassen Sie es so, wie es ist, weil gtkdocize nach GTK_DOC_CHECK am Anfang einer Zeile sucht.
# check for gtk-doc m4_ifdef([GTK_DOC_CHECK], [ GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) ],[ AM_CONDITIONAL([ENABLE_GTK_DOC], false) ])
Das erste Argument wird zur Überprüfung von gtkdocversion während des configure-Durchlaufs benutzt. Das zweite, optionale Argument wird von gtkdocize verwendet. Das Makro GTK_DOC_CHECK fügt verschiedene Schalter für configure hinzu:
- --with-html-dir=PATH : Pfad zur installierten Dokumentation
- --enable-gtk-doc : gtk-doc zur Erstellung der Dokumentation verwenden [Vorgabe=no]
- --enable-gtk-doc-html : Erstellung der Dokumentation im HTML-Format [Vorgabe=yes]
- --enable-gtk-doc-pdf : Erstellung der Dokumentation im PDF-Format [Vorgabe=no]
GTK-Doc ist standardmäßig deaktiviert! Denken Sie daran, die Option '--enable-gtk-doc' beim nächsten Durchlauf von configure zu übergeben. Anderenfalls wird die vorher erstellte Dokumentation installiert. Dies ergibt für Benutzer durchaus Sinn, aber nicht für Entwickler.
Furthermore it is recommended that you have the following line inside your configure.ac script. This allows gtkdocize to automatically copy the macro definition for GTK_DOC_CHECK to your project.
AC_CONFIG_MACRO_DIR(m4)
Nachdem alle Änderungen auf configure.ac angewendet wurden, aktualisieren Sie die Datei configure. Dies geschieht durch erneutes Ausführen von autoreconf -i oder autogen.sh.