GTK-Doc

GTK-DOCは、Cコードを文書化するために使用されます。これは、典型的には、GTK +とGNOMEライブラリなどのライブラリーのパブリックAPIを文書化するために使用されるが、それはまた、アプリケーション·コードを文書化するために使用することができます。
GTK-DOCはもともと汎用文書化ツールであることを意図していなかったことに注意してくださいので、セットアップと使いにくいビットであることができます。より洗練された汎用的な文書化ツールのためには、Doxygenの（http://www.doxygen.org/）を見てみたいことがあります。しかし、GTK-DOCは、GTK +のウィジェットや他のツールを持っていない可能性がありGObjectのクラスの信号と特性を文書化するためにいくつかの特別なコードを持っています。
GTK-DOCは、あなたのドキュメントは2つの方法で作成することができます：
a）は、特別にフォーマットされたコメントで、ソースコード内に埋め込ま。
または
B）すべてのヘッダファイルをスキャンし、宣言を構文解析した後、「テンプレート」ファイルのgtk-docの出力に追加されました。
これらのソースコードのコメントやテンプレートファイルGTK-DOCからのDocBook XML（またはSGML）をHTMLに変換された文書を生成します。生成されたHTMLドキュメントは、通常のWebブラウザで、または特別なDevhelp APIのブラウザを使用して閲覧することができます（http://developer.imendio.com/wiki/Devhelp).

Whatを参照してください。このリリースで追加されました：

このGTK-docのは、マークダウン（見出しやリスト）のサブセットをサポート - 参照
http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
古いdevhelpを生成しないのgtk-docのは、任意のより多くのファイル。これは、ドキュメントをダウンカット
発生時間とdevhelp＆GTの作品; = 0.11は、（2005年にリリースされました）。
外のソースディレクトリビルドの変更は、使用してプロジェクトのための破損の原因となりました
（builddirへの）相対パスでDOC_SOURCE_DIR。これは、使用することをお勧めします
DOC_SOURCE_DIR = $（top_srcdir）/ SRC / XXX。
変更
590927：DOC-ビルド工程をサポートAM_SILENT_RULES
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：ビットをconfigのアップデートのautotools
655711：パッケージによってdepscan出力をまとめます
656453：パフォーマンスの向上（PATCH）
656658：GTK-doc.make：別のディレクトリに構築するときにドキュメントをインストールしないターゲットをインストール
656773：GTK-docのは、「チャー*の定数」として宣言されたシンボルを見つけることができません
656946：GTK-DOC」のextern short int型 'を処理できません
657377：！SRCDIR = builddirはTMPLの内容を破棄ビルド
協力者
Bakaoukasニコラオス
クロードParoz
ダニエルMustieles
デビッドNecas
デビッドNEA ??など
ハビエルJardA³n
ホルヘ·ゴンザレス
マリオBlA¤ttermann
マティアスClasen
MichaA、GA³rny
ショーンMcCance
ステファン·ザウアー（KOST）
ウィル·トンプソン
YaakovのSelkowitz

この要件：

このPerlのバージョン5
libxsltは＆libxml2の2.3.6
DocBookのXSLスタイルシート
DocBookのXMLのDTD
DocBookのSGMLのDTD
ジェイドV1.1またはOpenJade 1.3.1
DocBookのDSSSLスタイルシート