がくぞうのアイデアブログ

思いついたアイデア、試したことを公開していきます。

WordpressのAPIドキュメントを作成してみた。

【スポンサーリンク】

Wordpressのソースを見たら、以下のようなコメントが書かれていました。

/**
* Tells WordPress to load the WordPress theme and output it.
*
* @var bool
*/
define('WP_USE_THEMES', true);

PHPDocumentor2を利用すれば、簡単にWordpressAPIドキュメントが作れると思い、
試してみました。
なにかの参考になればと思いますので、APIドキュメントの作成方法を残します。

1.PHPをインストールする

XAMPP 1.7.7をダウンロードして、インストールします。
このXAMPPをインストールすると、PHP 5.3.8がインストールされます。

2.PEARのアップグレード

コマンドプロンプトから以下のコマンドを入力します。

pear update-channels
pear upgrade pear
pear upgrade-all

3.PHPDocumentor2をインストールする

以下のコマンドを入力する。

pear channel-discover pear.phpdoc.org
pear install -a phpdoc/phpDocumentor-alpha

以下のコメントを入力して、バージョンを確認します。

phpdoc --version

私の環境では、以下のように表示されます。

phpDocumentor version 2.0.0a12

4. XML → HTML変換機能を有効にする

php.iniファイルに以下を追記する。

extension=php_xsl.dll

5.グラフ作成ソフトのインストー

PHPDocumentor2でAPIドキュメントを作成すると、
クラス継承図も作成されます。
クラス継承図を作成するのに、「GraphViz」が必要となります。

以下のアドレスからインストーラをダウンロードし、インストールします。
windows | Graphviz - Graph Visualization Software

私は、「graphviz-2.30.1.msi」を利用しました。

ちなみに、以下のようなクラス継承図が作成されます。

6.Wordpressをダウンロードする

Wordpressをダウンロードし、適当なフォルダに保存し、圧縮ファイルを展開します。
私は、Wordpress3.5.1をダウンロードしました。

7.WordpressAPIドキュメントを作成する

以下の様なコマンドを入力します。

phpdoc -d ソースファイルを保存しているフォルダパス -t APIドキュメントを保存するフォルダパス

以下は例です。
phpdoc -d C:\wordpress -t C:\api_doc

ちなみに、以下のようなAPIドキュメントが作成されます。
Twitter BootStrapを使っているみたいです。


作成したWordpressAPIドキュメントを公開しておきます。
phpDocumentor