MacとCentOSでDoxygenでいい感じのドキュメントを生成する

  • Pocket
  • このエントリーをはてなブックマークに追加
  • 162 follow us in feedly

まえがき

今回はDoxygenを使ってPHPのプログラムソースからドキュメントを生成してみます。

ちょっと使ってみて思ったことですが、Doxygenでは様々なプログラム言語に対応しており、Graphvizを使うことでリッチなドキュメントがつくれたり、設定ファイルを元にドキュメントを作成するので使いやすい。とかなりいいかんじでした。

てなわけで今回はMacでの環境とCentOSの環境でDoxygenを使えるように環境設定をしたいと思います。

開発環境

  • Mac OSX Mavericks
  • CentOS 6.5
  • Doxygen 1.8.7

Macでのインストール

Homebrewでdoxygenとgraphvizをインストールします

brew install doxygen
brew install graphviz

CentOSでのインストール

Doxygenに関してはyumからもインストールできるけど、バージョンが古かったのでソースからインストールしました。

wget http://ftp.stack.nl/pub/doxygen/doxygen-1.8.7.src.tar.gz
tar zxf doxygen-1.8.7.src.tar.gz
cd doxygen-1.8.7
./configure
make
make install
doxygen --version
1.8.7

設定ファイルの作成

ほいで『doxygen -g』コマンドでDoxyfileという設定ファイルを作成します。作成後はちょこちょこ設定をいじっていきます。

以下は自分が編集したところを抜粋しています

PROJECT_NUMBER         = 1
OUTPUT_DIRECTORY       = build/doxygen
OUTPUT_LANGUAGE        = Japanese
JAVADOC_AUTOBRIEF      = YES
EXTRACT_ALL            = YES
INPUT                  = ./fuel/core ./fuel/app
FILE_PATTERNS          = *.php *.inc
RECURSIVE              = YES
HAVE_DOT               = YES
CALL_GRAPH             = YES
CALLER_GRAPH           = YES

INPUTを複数入力することもできるようです

実際にドキュメントを生成してみる

では、実際にドキュメントを生成する。以下のコマンドでドキュメントができあがる。

doxygen ./Doxyfile

doxygen-mac-centos-1

おすすめ書籍

継続的インテグレーション入門
ポール・M・デュバル スティーブ・M・マティアス アンドリュー・グローバー
日経BP社
売り上げランキング: 103,097

関連記事

Screeny Shot 2013-07-20 17.51.43.png

【WordPressプラグイン】ニコニコのマイリスト内の動画を一覧表示する

まえがき ニコニコ動画のマイリストに登録してある動画を一覧で表示するプ...

記事を読む

images-1

PEARライブラリphpDocumentor2を使って楽々ドキュメント作成

まえがき GWも終わって普段の生活に戻り5月病にかかった私ですが、 ...

記事を読む

FuelPHPのユニットテスト時に環境変数で接続するDBを切り替える

まえがき さて、何をやりたいかというと。 ユニットテスト時にはユニット...

記事を読む

MacにPHP5.5をインストールする

まえがき Macには標準でPHP5.3かなんかがインストールされている...

記事を読む

【読書感想文】「プロになるためのWeb技術入門」を読んで

まえがき 冬休みもに入って1週間が立ってしまった。 特に冬休み中にやら...

記事を読む

新着記事

no image

PHPでRubyのirbっぽいインタラクティブなスクリプトが実行できる「boris」

まえがき PHPでもRubyのirbみたいなことがしたくて探してみたと...

記事を読む

2015年の抱負と去年の振り返り〜よちよちWEB業界1年経験して〜

まえがき あけましておめでとうございます。今年もどうぞよろしくお願いし...

記事を読む

Java SE 7 Bronze試験(1Z0-802)を受けてきました

まえがき 以前から少し受けてみたかった試験『Java SE 7 Bro...

記事を読む

HubotでJenkinsのジョブを実行する

まえがき HubotをつかってJenkinsのジョブをじっこうしてみた...

記事を読む

no image

Hubotをforeverでデーモン化する

まえがき 今回はHubotをforeverを使ってデーモン化してみた時...

記事を読む

スポンサーリンク

  • Sorry. No data so far.

PAGE TOP ↑