Symfoware

Symfowareについての考察blog

DebianにphpDocumentorをインストールし、mantisのソースを解析する

MantisのPluginを作ってみたのですが、mantisに用意されている
apiを探すのが非常に面倒でした・・・
Mantis関連の記事一覧(Pluginを作成する手順等)


ADOdb関連ドキュメント
こちらのページを参考にしているとき、

ADOdbソースドキュメントは、phpDocumentorで生成したADOdbのドキュメントです。



phpDocumentors
JavaDoc風のドキュメントを生成してくれる模様。
Debianにインストールして、mantisのソースを解析してみます。




インストール



apt-getでphp-pearを突っ込んで、pearでPhpDocumentorをインストール。


# apt-get install php-pear
# pear install --alldeps PhpDocumentor



pearって初めてつかったんですが、Pythonのeasy_installみたいなものでしょうか?
以下のメッセージとともに、インストールが終わりました。


downloading PhpDocumentor-1.4.3.tgz ...
Starting to download PhpDocumentor-1.4.3.tgz (2,423,486 bytes)
..................................................................................................done: 2,423,486 bytes
downloading XML_Beautifier-1.2.2.tgz ...
Starting to download XML_Beautifier-1.2.2.tgz (14,587 bytes)
...done: 14,587 bytes
downloading XML_Parser-1.3.4.tgz ...
Starting to download XML_Parser-1.3.4.tgz (16,040 bytes)
...done: 16,040 bytes
downloading XML_Util-1.2.1.tgz ...
Starting to download XML_Util-1.2.1.tgz (17,729 bytes)
...done: 17,729 bytes
install ok: channel://pear.php.net/PhpDocumentor-1.4.3
install ok: channel://pear.php.net/XML_Parser-1.3.4
install ok: channel://pear.php.net/XML_Util-1.2.1
install ok: channel://pear.php.net/XML_Beautifier-1.2.2






phpdocによるドキュメントの生成



phpdocというコマンドでソースの解析を行います。


# phpdoc -t [出力ディレクトリ] -d [解析ソースのディレクトリ] -o [出力するフォーマット]




Mantisのソースを解析していると、Oracle接続系のライブラリ解析中に
落ちてしまうようです。
※エラーメッセージがないので詳細不明

一旦ソースのコピーをとり、不要なソースを削除。
その後解析を実行しました。


コピーと解析不要ディレクトリの削除。


# cp -R /var/www/mantis /var/www/mantis-src
# rm -fr /var/www/mantis-src/api
# rm -fr /var/www/mantis-src/css
# rm -fr /var/www/mantis-src/doc
# rm -fr /var/www/mantis-src/docbook
# rm -fr /var/www/mantis-src/images
# rm -fr /var/www/mantis-src/javascript
# rm -fr /var/www/mantis-src/lang
# rm -fr /var/www/mantis-src/library
# rm -fr /var/www/mantis-src/plugins
# rm -fr /var/www/mantis-src/tests




ドキュメントの生成


phpdoc -t /var/www/mantis-doc -d /var/www/mantis-src -o HTML:Smarty:PHP




生成されたドキュメントはこんな感じ。

10_001_20101212214540.png



以下のURLにアップロードしておきました。
http://symfo.web.fc2.com/mantis-doc/


これで、多少プラグインの開発が楽になるはず・・・




【参考URL】

How to install PhpDocumentor on Ubuntu
phpDocumentorでドキュメント作成












関連記事

テーマ:プログラミング - ジャンル:コンピュータ

  1. 2010/12/12(日) 21:47:43|
  2. mantis
  3. | トラックバック:0
  4. | コメント:0
  5. | 編集
次のページ