Τεκμηρίωση

Μπορεί να θέλετε να επαναχρησιμοποιήσετε την τεκμηρίωση που υπάρχει για τη βιβλιοθήκη C που συσκευάζετε. Οι βιβλιοθήκες C τεχνοτροπίας GTK χρησιμοποιούν τυπικά gtk-doc και συνεπώς έχουν σχόλια πηγαίου κώδικα μορφοποιημένα για gtk-doc και κάποια πρόσθετη τεκμηρίωση σε αρχεία .sgml και .xml. Το σενάριο docextract_to_xml.py, από τον κατάλογο tools/defs_gen του glibmm, μπορεί να διαβάσει αυτά τα αρχεία και να δημιουργήσει ένα αρχείο .xml που μπορεί να χρησιμοποιήσει την gmmproc για να δημιουργήσει σχόλια doxygen. Η gmmproc θα προσπαθήσει ακόμα να μετασχηματίσει την τεκμηρίωση για να την κάνει πιο κατάλληλη για μια API C++.

For instance,

./docextract_to_xml.py -s ~/checkout/gnome/gtk+/gtk/ > gtk_docs.xml

Επειδή αυτός ο αυτόματος μετασχηματισμός δεν είναι πάντα κατάλληλος, μπορεί να θελήσετε να δώσετε χειρόγραφο κείμενο για μια συγκεκριμένη μέθοδο. Μπορείτε να το κάνετε αντιγράφοντας τον κόμβο XML για τη συνάρτηση από το αρχείο σας something_docs.xml στο αρχείο something_docs_override.xml και να αλλάξετε τα περιεχόμενα.

Αν αντιγράφετε το πηγαίο δένδρο σκελετού σε mm-common και αντικαταστήσετε το κείμενο του δεσμευτικού θέσης, τότε θα έχετε ήδη κατάλληλα αρχεία Makefile.am και Doxyfile.in. Με την εγκατάσταση δόμησης mm-common, η λίστα των αρχείων εισόδου Doxygen δεν ορίζεται στο αρχείο ρυθμίσεων Doxygen, αλλά περνά από την make στην τυπική είσοδο της doxygen. Η λίστα αρχείων εισόδου ορίζεται από τη μεταβλητή doc_input στο αρχείο Makefile.am.