GTK-Doc

GTK-Doc służy do dokumentowania kodu C. To jest zwykle używany do dokumentowania publicznego API bibliotek, takich jak biblioteki GTK + oraz GNOME, ale może być również używany do dokumentowania kodu aplikacji.
Należy pamiętać, że GTK Doc nie był pierwotnie pomyślany jako narzędzie dokumentacji ogólnego przeznaczenia, więc może być nieco kłopotliwe w instalacji i użyciu. Dla bardziej dopracowany celów dokumentacyjnych ogólnego przeznaczenia może warto spojrzeć na Doxygen (http://www.doxygen.org/). Jednak GTK-Doc ma jakiś specjalny kod dokumentujący sygnały i właściwości widżetów GTK + i klas gobject których inne narzędzia mogą nie mieć.
GTK-Doc pozwala dokumentacja być napisane na 2 sposoby:
) Wbudowany wewnątrz kodu źródłowego w specjalnie sformatowanych komentarzy.
lub
b) Dodane do plików "szablon", które wyjścia gtk-doc po zeskanowaniu wszystkich plików nagłówka i analizowania oświadczeń.
Z tych komentarzy kodu źródłowego i plików szablonów GTK-Doc generuje Docbook XML (lub SGML) dokument, który następnie przekształcił się w HTML. Dokumentacja HTML wygenerowany można przeglądać w zwykłej przeglądarki internetowej lub za pomocą specjalnej przeglądarki Devhelp API (patrz http://developer.imendio.com/wiki/Devhelp).

What jest nowy w tym wydaniu:

• gtk-doc obsługuje podzbiór przecen (nagłówków i list) - patrz,
• http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
• gtk-doc nie generuje plików stary Devhelp więcej. To skraca doc
• Czas generacji i pracuje dla Devhelp & gt;. = 0,11 (został wydany w 2005 roku),
• zmiany na out-of-źródła spowodowane uszkodzeniem budowy reż projektów przy użyciu
• DOC_SOURCE_DIR ze ścieżki względnej (do builddir). Zaleca się używać
• DOC_SOURCE_DIR = $ (top_srcdir) / src / xxx.
• Zmiany
• 590927: AM_SILENT_RULES wsparcia dla kroków doc-zbudować
• 617121 / * & lt; prywatne & gt; * / Deklaracje w teksty stałe wciąż są wyświetlane
• 627758: sposób zignorować symbol
• 639145: skrótowa składnia pozycjach,
• 644291: przerwy Enum parser przelewu ")"
• 646870: nie ma już w EXTRA_DIST HTML_IMAGES
• 648289:. Gtkdoc-mkdb nie kompiluje
• 648331:. Określ opcje dla kompatybilnych podświetleniem "konsekwentnie"
• 649269: gtkdoc-scanobj należy ustawić niektóre z własnymi flagami / LDFLAGS
• 650407: Budynki docs podczas distchecking produkuje tysiące € Ono oświadczenie o Fundację € ?? ostrzeżenia, to się nie powiedzie.
• 652746: Dokumentacja prostych pudełkowych strukturach uszkodzony
• 652764: autotools aktualizacji konfiguracji trochę
• 655711: podsumowanie wyjście depscan przez pakiet
• 656453: Poprawa wydajności (łata)
• 656658: gtk-doc.make: zainstaluj cel nie zainstalować dokumentacji przy budowie w oddzielnym katalogu
• 656773: gtk-doc nie znajdzie symbol zadeklarowany jako "char * const '
• 656946: gtk-doc w stanie obsłużyć "extern krótkie int"
• 657377: SRCDIR = builddir buduje wyrzucić zawartość tmpl
• Autorzy
• Bakaoukas Nikolaos
• Claude Paroz
• Daniel Mustieles
• David Necas
• David Nea ?? a,
• Javier JardA³n
• Jorge Gonzalez
• Mario BlA¤ttermann
• Matthias Clasen
• MichaA, GA³rny
• Shaun McCance
• Stefan Sauer (Kost)
• Will Thompson
• Yaakov Selkowitz

Wymagania :

• Perl v5
• libxslt i libxml2 2.3.6
• Arkusze stylów XSL DocBook
• DocBook XML DTD
• DocBook SGML DTD
• Jade v1.1 lub OpenJade 1.3.1
• DocBook DSSSL Arkusze stylów