Integrace s autoconf
Velmi snadné! Stačí jen přidat jeden řádek do vašeho skriptu configure.ac.
# check for gtk-doc GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
Vyžaduje to, aby všichni vývojáři měli gtk-doc nainstalované. Jestli u vašeho projektu stačí mít sestavení dokumentaci k API jen volitelné, můžete to vyřešit podle vzoru níže. Použijte to přesně tak, jak je uvedeno, protože gtkdocize hledá GTK_DOC_CHECK na začátku řádku.
# check for gtk-doc m4_ifdef([GTK_DOC_CHECK], [ GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) ],[ AM_CONDITIONAL([ENABLE_GTK_DOC], false) ])
První argument se používá ke kontrole gtkdocversion v průběhu konfigurace. Druhý, volitelný argument používá nástroj gtkdocize. Makro GTK_DOC_CHECK také přidává několik přepínačů pro configure:
- --with-html-dir=CESTA: cesta, kam se má dokumentace nainstalovat
- --enable-gtk-doc: použít k sestavení dokumentace gtk-doc [výchozí je ne]
- --enable-gtk-doc-html: sestavit dokumentaci ve formátu HTML [výchozí je ano]
- --enable-gtk-doc-pdf: sestavit dokumentaci ve formátu PDF [výchozí je ne]
GTK-Doc je standardně vypnuté! Nezapomeňte zadat přepínač „--enable-gtk-doc“ při dalším spuštění configure. Jinak se nainstaluje předgenerovaná dokumentace (která může mít význam pro uživatele, ale ne pro vývojáře).
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)
Po provedení změn v configure.ac aktualizujte soubor configure. To se dá udělat opětovným spuštěním autoreconf -i nebo autogen.sh.