GTK-Doc

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

What нового У цьому випуску:

• GTK-Doc підтримує підмножина уцінки (заголовків та списків) - див
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• GTK-Doc не створює старий Devhelp файли більше. Це скорочує документ
• Час генерації і працює на Devhelp & GT ;. = 0,11 (був випущений в 2005 році)
• зміни на поза-джерела реж збірки викликало поломку для проектів з використанням
• DOC_SOURCE_DIR з відносний шлях (в builddir). Рекомендується використовувати
• DOC_SOURCE_DIR = $ (top_srcdir) / SRC / ххх.
• Зміни
• 590927: Підтримка AM_SILENT_RULES для Doc-побудувати кроків
• 617121: / * & Lt; приватний & GT; * / Декларації в переліках все ще відображається
• 627758: спосіб ігнорувати символ
• 639145: скорочений синтаксис для заголовків
• 644291: Перерахування аналізатор перерви на поступки ") '
• 646870: більше не EXTRA_DIST HTML_IMAGES
• 648289 :. Gtkdoc-mkdb не складає
• 648331 :. Вкажіть сумісні варіанти "родзинкою" послідовно
• 649269: gtkdoc-scanobj повинні встановити деякі з його власних CFLAGS / LDFLAGS
• 650407: Будинки документи, а distchecking виробляє тисячі в € Воно декларація founda € ?? попередження, то не вдається.
• 652746: Документація простих коробках структур порушена
• 652764: Оновлення Autotools Config трохи
• 655711: узагальнити depscan вихід пакетом
• 656453: підвищення продуктивності (Patch)
• 656658: GTK-doc.make: встановити ціль не встановити документацію при будівництві в окремому каталозі
• 656773: GTK-Doc не вдається знайти символ оголошений як "символ * сопзЬ '
• 656946: GTK-Doc не в змозі впоратися "Екстерн короткий Int
• 657377: SRCDIR = builddir будує відкинути вміст TMPL
• Автори
• Bakaoukas Ніколаос
• Клод Paroz
• Даніель Mustieles
• Девід Нечас
• Девід Неа ?? а
• Хав'єр JardA³n
• Хорхе Гонсалес
• Маріо BlA¤ttermann
• Маттіас Clasen
• MichaA, GA³rny
• Шон McCance
• Стефан Sauer (Кость)
• Уїлл Томпсон
• Яків Selkowitz

Вимоги

• Perl версії 5
• LibXSLT і libxml2 2.3.6
• DocBook XSL стилів
• DocBook XML DTD
• DocBook SGML DTD
• Джейд v1.1 або OpenJade 1.3.1
• DocBook DSSSL стилів