Ενσωμάτωση στο autoconf
Πολύ εύκολα! Απλά προσθέτετε μία γραμμή στη δέσμη ενεργειών configure.ac.
# έλεγχος για gtk-doc GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
Αυτό απαιτεί από όλους τους προγραμματιστές να έχουν εγκατεστημένο το gtk-doc. Αν είναι εντάξει για το έργο σας να έχετε μια επιπλέον δόμηση ρυθμίσεων για το api-doc, μπορείτε να το επιλύσετε όπως αναφέρεται παρακάτω. Αφήστε το ως έχει, όσο το gtkdocize αναζητά την αρχή της σειράς για το GTK_DOC_CHECK.
# έλεγχος για gtk-doc m4_ifdef([GTK_DOC_CHECK], [ GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) ],[ AM_CONDITIONAL([ENABLE_GTK_DOC], false) ])
Το πρώτο όρισμα χρησιμοποιείται για έλεγχο του gtkdocversion κατά τη ρύθμιση. Το δεύτερο, προαιρετικό όρισμα χρησιμοποιείται από το gtkdocize. Η μακροεντολή GTK_DOC_CHECK επίσης προσθέτει αρκετούς διακόπτες ρύθμισης:
- --with-html-dir= PATH : διαδρομή προς την εγκατεστημένη τεκμηρίωση
- --enable-gtk-doc : χρήση gtk-doc για τη δόμηση τεκμηρίωσης [προεπιλογή=no]
- --enable-gtk-doc-html : δόμηση τεκμηρίωσης σε μορφή html [προεπιλογή=yes]
- --enable-gtk-doc-pdf : δόμηση τεκμηρίωσης σε μορφή pdf [προεπιλογή=no]
Το GTK-Doc είναι απενεργοποιημένο από προεπιλογή! Να θυμάστε να χρησιμοποιείτε την επιλογή '--enable-gtk-doc' στην επόμενη εκτέλεση του configure. Διαφορετικά, εγκαθίσταται η προπαραχθείσα τεκμηρίωση (δυνατότητα χρήσιμη για τον χρήστη, αλλά όχι για τον προγραμματιστή).
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)
Όταν όλες οι αλλαγές στο configure.ac έχουν γίνει, ενημερώστε το αρχείο configure. Αυτό μπορείτε να το κάνετε επανεκετελώντας το autoreconf -i ή το autogen.sh.