Integration in autoconf

Sehr einfach! Fügen Sie eine Zeile zu Ihrem configure.ac-Skript hinzu.

Beispiel 2-2Integration in autoconf
# check for gtk-doc
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])

          

This will require all developers to have gtk-doc installed. If it is okay for your project to have optional api-doc build setup, you can solve this as below. Keep it as is, as gtkdocize is looking for GTK_DOC_CHECK at the start of a line.

Beispiel 2-3Keep gtk-doc optional
# 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:

  1. --with-html-dir=PATH : Pfad zur installierten Dokumentation
  2. --enable-gtk-doc : gtk-doc zur Erstellung der Dokumentation verwenden [Vorgabe=no]
  3. --enable-gtk-doc-html : Erstellung der Dokumentation im HTML-Format [Vorgabe=yes]
  4. --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.

Weiterhin ist es empfehlenswert, dass das configure.ac-Skript die folgende Zeile enthält. Dies erlaubt gtkdocize das automatische Kopieren der Makrodefinition für GTK_DOC_CHECK in Ihr Projekt.

Beispiel 2-4Vorbereitung für gtkdocize
AC_CONFIG_MACRO_DIR(m4)