GTK-Doc-1.33.2

GTK-Doc の概要

GTK-Doc パッケージは、コードから文書を作るためのツールを提供します。 コード内に記述された所定書式のコメントから、API ドキュメントを生成します。 このパッケージはオプションであって、もしインストールされていない場合、各種パッケージはドキュメントを生成しません。 このことは、ドキュメントが一切得られないことを意味するわけではありません。 GTK-Doc が利用できない場合は、各パッケージのインストール処理において、事前にビルドされているドキュメントがコピーされます。

[注記]

注記

LFS や依存パッケージが本ブックに示す最新安定バージョンでなかった場合には、BLFS 開発版においては、パッケージのビルドや処理実行が適切に行われないことがあります。

パッケージ情報

GTK-Doc の依存パッケージ

必須

docbook-xml-4.5, docbook-xsl-nons-1.79.2, itstool-2.0.7, libxslt-1.1.39

推奨

Optional

For tests: dblatex or fop-2.9 (XML PDF support), GLib-2.78.3, Which-2.21, and Python modules lxml-4.9.4, parameterized, and yelp-tools

[注記]

注記

The optional python modules above can be easily installed with the pip3 command.

GTK-Doc のインストール

以下のコマンドを実行して GTK-Doc をビルドします。

autoreconf -fiv           &&
./configure --prefix=/usr &&
make

テストスイートはパッケージをまだインストールしていない (あるいは前バージョンをインストールしていない) 場合には失敗します。

root ユーザーになって以下を実行します。

make install

To test the results, issue: make check. Some tests will fail depending on optionally installed packages.

パッケージ構成

インストールプログラム: gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkhtml2, gtkdoc-mkman, gtkdoc-mkpdf, gtkdoc-rebase, gtkdoc-scan, gtkdoc-scangobj
インストールライブラリ: None
インストールディレクトリ: /usr/share/gtk-doc, /usr/share/cmake/GtkDoc

概略説明

gtkdoc*

these are all shell, or Python scripts used by package Makefile scripts to generate documentation for the package being built