開発版のソースコードをHTML化する

Last-modified: 2017-04-27 (木) 19:54:55

Wesnoth 開発版のソースコードは次のサイトで確認できます。
http://devdocs.wesnoth.org/
これが、どういう仕組なのかという説明です。

ドキュメンテーションジェネレータ (documentation generator)

ソースコードのファイルから、ドキュメント(仕様書)を作成してくれるツールです。
ソフトウェア開発において、ソースコードと仕様書の記述が食い違うという問題が昔からありました。
この問題の解決策として、ソースコードに書かれたコメント(注釈)からドキュメントを抽出するという方法が考えられました。
この手のツールとしてはJava言語のJavaDocが有名です。
JavaDocの成功により、他のプログラミング言語でもドキュメンテーションジェネレータが使われるようになりました。

Wkipedia -ドキュメンテーションジェネレータ

Doxygen と Graphviz

Doxygen

DoxygenはC/C++のソースファイルを解析してドキュメントを生成するプログラムです。

Graphviz

Doxygenがコールグラフ(関数の呼び出し関係の図)を作成するのに使います。

これらのツールを使うことにより、ソースファイルをHTML化しています。

インストール

Ubuntu の場合

sudo apt install doxygen graphviz

Windows や OSX のインストール方法は自分で調べてください。

使い方
Doxygenには設定ファイル Doxyfile が必要ですが、これはすでにソースファイルの中に含まれています。
なので、端末を起動し、Doxyfile があるディレクトリに移動して、

doxygen

と入力すると、ドキュメント(htmlファイル)が作成されます。
具体的には、doc/doxtgen/htmlというディレクトリが作られ、その中にhtmlファイルが作られます。
すべてのhtmlファイルを作成するのに少し時間がかかります。

Doxyfileの設定を変えることで、さまざまな調整ができます。
例えば、pdf ファイルに出力したり、見出しを日本語化したりできます。
(日本語化しても本文が英語なので、あまり変わりませんが )
詳しいことはDoxygenのマニュアルを参照してください。