Doxygenのインストール

Doxygenで,Lhazのソースコードからドキュメントを生成します。

まず,インストールです。

$ sudo apt-get install doxygen

doxyfile を作成します。Webコンテンツ向けに,/var/www にLhazのソースを git clone / pullしているので,/var/www に doxyfile を作成します。

$ cd /var/www
$ sudo doxygen -g doxyfile

ドキュメントの出力先ディレクトリを作成します。

$ cd public_html
$ sudo mkdir doxtgen

doxyfileを編集します。

$ cd /var/www
$ sudo vi doxyfile

(変更部分)
PROJECT_NAME           = Lhaz
OUTPUT_DIRECTORY       = /var/www/public_html/doxygen
OUTPUT_LANGUAGE        = Japanese
INPUT                  = /var/www/lhaz
INPUT_ENCODING         = SHIFT_JIS
などです。

/etc/cron.daily にドキュメント生成スクリプトを作成します。

$ sudo vi /etc/cron.daily/doxygen

#!/bin/sh
cd /var/www
doxygen doxyfile

$ sudo chmod +x /etc/cron.daily/doxygen

動作確認です。

$ sudo /etc/cron.daily/doxygen
$ curl http://192.168.1.7/doxygen/html/

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>Lhaz: メインページ</title>
...略...

無事ドキュメントが生成されました。

コメント

コメントを残す

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