GTK-Doc

GTK-Doc се използва за документиране на C код. Той обикновено се използва за документиране на публичен API на библиотеки, като GTK + и GNOME библиотеки, но може да бъдат използвани за документиране код приложение.
Имайте предвид, че GTK-Doc първоначално не е било предназначено да бъде инструмент с общо предназначение, документация, така че тя може да бъде малко неудобно за инсталиране и използване. За по-полиран средство за документиране с общо предназначение, може да искате да погледнете Doxygen (http://www.doxygen.org/). Въпреки GTK-Doc има някакъв специален код за документиране на сигналите и свойствата на GTK + джунджурии и GObject класове, които други инструменти не могат да имат.
GTK-Doc позволява документацията да бъде написана по 2 начина:
а) във вътрешността на изходния код в специално форматирани коментари.
или
б) добавя към "шаблонни" файлове, които GTK-док изходи след сканиране всички заглавни файлове и разбор на декларациите.
От тези коментари изходния код и шаблонни файлове GTK-Doc генерира Docbook XML (или SGML) документ, който след това се превръща в HTML. Генерираният HTML документация може да се браузва в обикновен уеб браузър или чрез използване на специален Devhelp API браузъра (виж http://developer.imendio.com/wiki/Devhelp).

What е нов в тази версия:

• GTK-док поддържа подмножество на евтино (позиции и списъци) - виж
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• GTK-док не генерира стари devhelp файлове повече. Това съкращава док
• поколение време и работи за devhelp & GT;. = 0,11 (е издаден през 2005 г.)
• промени за извън-източник реж строителство, причинени счупване на проекти чрез
• DOC_SOURCE_DIR с относителен път (да builddir). Препоръчително е да използвате
• DOC_SOURCE_DIR = $ (top_srcdir) / SRC / ххх.
• промени
• 590927: Подкрепа AM_SILENT_RULES за док-изгради стъпки
• 617121: / * & LT; частния & GT; * / Декларации в enums все още се появява
• 627758: начин да се игнорира символ
• 639145: стенограмите синтаксис за позиции
• 644291: Enum инструмента за синтактичен паузи по задание на ")"
• 646870: вече не е в EXTRA_DIST HTML_IMAGES
• 648289:. Gtkdoc-mkdb не съставят
• 648331:. Посочете съвместими опции за "осветяване" постоянно
• 649269: gtkdoc-scanobj трябва да зададете някои от нейните собствени CFLAGS / LDFLAGS
• 650407: Сгради Документи докато distchecking произвежда хиляди за € Оно декларация фондацията € ?? предупреждения, а след това се провали.
• 652746: Документация за обикновен опаковка structs разбито
• 652764: Актуализация autotools довереник малко
• 655711: обобщим depscan изход от пакетите
• 656453: подобрения в производителността (пластир)
• 656658: GTK-doc.make: инсталиране на целевата не се инсталира Документи при изграждане в отделна директория
• 656773: GTK-док не успее да намери символ обявена като "Чар * Конст"
• 656946: GTK-док в състояние да се справят с "ученик кратко INT"
• 657377:! 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
• Стефан Sauer (Кост)
• Уил Томпсън
• Яков 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