GTK-Doc

GTK-Doc χρησιμοποιείται για την τεκμηρίωση κώδικα C. Είναι συνήθως χρησιμοποιείται για την τεκμηρίωση της κοινό API των βιβλιοθηκών, όπως το GTK + και GNOME, αλλά μπορεί επίσης να χρησιμοποιηθεί για την τεκμηρίωση κώδικα εφαρμογής.
Σημειώστε ότι το GTK-Doc δεν προοριζόταν αρχικά να είναι ένα εργαλείο τεκμηρίωσης γενικής χρήσης, έτσι ώστε να μπορεί να είναι λίγο δύσκολη για την εγκατάσταση και τη χρήση. Για μια πιο γυαλισμένο βοήθημα τεκμηρίωσης γενικής χρήσης μπορεί να θέλετε να εξετάσουμε Doxygen (http://www.doxygen.org/). Ωστόσο GTK-Doc έχει κάποιο ειδικό κωδικό για να τεκμηριώσει τα σήματα και τις ιδιότητες του GTK + widgets και τάξεις GObject που μπορεί να μην έχουν άλλα εργαλεία.
GTK-Doc επιτρέπει την τεκμηρίωση σας να είναι γραμμένο με 2 τρόπους:
α) Τα ενσωματωμένα στο εσωτερικό του πηγαίου κώδικα σε ειδικά διαμορφωμένη σχόλια.
ή
β) που προστίθεται στο «πρότυπο» αρχεία τα οποία εξόδους gtk-doc μετά τη σάρωση όλα τα αρχεία κεφαλίδας και ανάλυσης των δηλώσεων.
Από τις παρατηρήσεις αυτές του πηγαίου κώδικα και αρχεία προτύπων GTK-Doc παράγει ένα Docbook XML (ή SGML) έγγραφο, το οποίο στη συνέχεια μετατρέπεται σε HTML. Το παραγόμενο HTML τεκμηρίωση μπορεί να περιηγηθεί σε ένα συνηθισμένο πρόγραμμα περιήγησης στο Web ή μέσω του ειδικού προγράμματος περιήγησης Devhelp API (βλέπε http://developer.imendio.com/wiki/Devhelp).

What είναι νέα σε αυτή την έκδοση:

• gtk-doc υποστηρίζει ένα υποσύνολο των markdown (κατηγορίες και τους καταλόγους) - δείτε το
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc δεν δημιουργεί παλιά devhelp αρχεία πια. Αυτό μειώνει doc
• χρόνος γένεσης και εργάζεται για devhelp & gt?. = 0,11 (κυκλοφόρησε το 2005)
• αλλαγές για out-of-πηγής σκην κατασκευής προκαλείται θραύση για τα έργα χρησιμοποιώντας τα
• DOC_SOURCE_DIR με μια σχετική διαδρομή (με builddir). Συνιστάται να χρησιμοποιείτε
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Αλλαγές
• 590927: AM_SILENT_RULES στήριξης για τις ενέργειες doc-οικοδομήσουμε
• 617121: / * & lt? ιδιωτικού & gt? * / Οι δηλώσεις στο enums εξακολουθεί να εμφανίζεται
• 627758: Ένας τρόπος για να αγνοήσει ένα σύμβολο
• 639145: στενογραφία σύνταξη για τους τίτλους
• 644291: διαλείμματα κλικΑπαρίθμηση αναλυτή για την εκχώρηση των «)»
• 646.870: δεν είναι πλέον σε EXTRA_DIST HTML_IMAGES
• 648289:. Gtkdoc-mkdb δεν καταρτίζει
• 648331:. Καθορίστε συμβατές επιλογές για «αποκορύφωμα» με συνέπεια
• 649269: gtkdoc-scanobj θα πρέπει να θέσει κάποιες από τις δικές CFLAGS του / LDFLAGS
• 650407: Κτίρια docs ενώ distchecking παράγει χιλιάδες σε € Ono δήλωση Φουντά € ?? προειδοποιήσεις, τότε αποτυγχάνει.
• 652746: Τεκμηρίωση του απλού κουτί structs σπασμένα
• 652764: Ενημέρωση autotools config λίγο
• 655711: συνοψίζουν depscan έξοδος από το πακέτο
• 656453: Βελτιώσεις στην απόδοση (PATCH)
• 656658: gtk-doc.make: εγκατάσταση στόχος δεν εγκαθιστά docs κατά την οικοδόμηση σε ξεχωριστό κατάλογο
• 656773: gtk-doc αδυνατεί να βρει ένα σύμβολο που δηλώθηκαν ως «char * const"
• 656946: gtk-doc θέση να χειριστεί «extern σύντομη int '
• 657.377! Srcdir = builddir χτίζει απορρίψετε το περιεχόμενο των tmpl
• Συνεργασίες
• Bakaoukas Νικόλαος
• Claude Paroz
• Ο Daniel Mustieles
• Ο David Νέκας
• Ο David Νέα ?? ως
• Javier JardA³n
• Ο Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Ο Shaun McCance
• Ο Stefan Sauer (Kost)
• Θα Thompson
• Yaakov Selkowitz

Απαιτήσεις :

• Perl v5
• libxslt & libxml2 2.3.6
• DocBook XSL Stylesheets
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 ή OpenJade 1.3.1
• DocBook DSSSL Stylesheets