GTK-Doc

GTK-Doc используется для документирования C код. Это, как правило, используется для документирования общественного API библиотек, таких как GTK + и библиотек GNOME, но он также может быть использован для документирования кода приложения.
Обратите внимание, что GTK-Doc изначально не предназначен, чтобы быть общего назначения инструмент документации, поэтому он может быть немного неудобно в установке и использовании. Для более полированной инструмент документации общего назначения вы можете смотреть на Doxygen (http://www.doxygen.org/~~HEAD=pobj). Однако GTK-Doc имеет специальный код, чтобы документировать сигналы и свойства GTK + виджетов и классов, которые GObject другие инструменты могут не иметь.
GTK-Doc позволяет ваша документация будет написана в 2 способами:
а) Embedded внутри исходного кода в специально отформатированных комментариев.
или
б) занесен в "шаблонных" файлов, который выводит 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 стилей