GTK-Doc-1.32

GTK-Doc の概要

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

本パッケージは LFS-9.0 において正しくビルドでき動作することが確認されています。

パッケージ情報

GTK-Doc の依存パッケージ

必須

docbook-xml-4.5, docbook-xsl-1.79.2, itstool-2.0.6, libxslt-1.1.34

推奨

任意

テスト向け: dblatex または fop-2.4 (XML PDF サポート), GLib-2.62.4, Which-2.21, Python モジュール lxml-4.5.0, anytree, parameterized

[注記]

注記

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

ユーザー情報: http://wiki.linuxfromscratch.org/blfs/wiki/gtk-doc

GTK-Doc のインストール

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

./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
インストールライブラリ: なし
インストールディレクトリ: /usr/share/gtk-doc, /usr/share/help/*/gtk-doc-manual

概略説明

gtkdoc*

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

最終更新日: 2020-02-17 08:15:05 +0900