Doxygenの出力をLatex経由でPDF化する

By | 2018年8月17日

DoxygenのHTML出力はクリッカブル・リンクが大変便利です。

一方で、このHTML出力は検索エンジンをカスタム化しない限り、検索機能が非常に限られるという欠点があります。デフォルトでは抽出済みキーワードしか検索対象にならないため、「思いついたキーワードで検索する」という、初学者がよくやる手が使えません。

そこで、PDF化することにしました。

Doxygen文書のPDF化には2つの方法があります。

  1. RTFで出力してMS WORDからPDFに変換する
  2. LaTeXで出力してPDFに変換する

1は試したことがありますが、手間がかかる割に出力が汚く、実用に耐えません。

長いこと2を試そうと思っていたのですがTeXの経験が皆無でしたので二の足を踏んでいました。今回ようやく踏み切ったわけです。

TeX Liveのインストール

TeXは情報が膨大である一方、あまりにも歴史が古く、しかも多くの人が各地でサポートしたために取っ掛かりがわからず苦労しました。結論から言えば、TeX LiveからDVDイメージをダウンロードしてインストール・スクリプトを走らせれば終わりです。

インストール・スクリプトには複数あるためどれを走らせればよいか、予め調べておきましょう。現時点ではUnixはinstall-tl、Windowはinstall-tl-windowsです。

なお、Windows版は実行後にパスまでセットしてくれますが、Unix版はそこまではやってくれませんので、最後に表示されるパスを自分で.bashrcに設定します。

作業が全部終わったら、簡単なコマンドを実行してパスが通っているか調べましょう。

pdflatex

Doxygenの設定

LaTeXを使うようDoxygenを設定します。私はEclispeからeclox経由でdoxygenを使っています。

ecloxによるDoxygen設定画面

あとは、Doxygenを実行するだけです。実行するとlatexディレクトリに以下のようなものが生成されます。

  • 中間TeXファイル
  • 中間PDFファイル
  • Makefile

ここでmakeを実行すれば最終出力のPDFファイルが生成されます。

まとめ

食わず嫌いのLaTeXですが、Doxygen経由で使う分にはタグ打ち等は不要ですので気楽です。とはいえ、章タイトルはHTML文書用のままでは座りが悪いように思えます。

Doxygenコメントを打つときに、PDF化を考えながら作業する必要がありそうです。

 

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください