PhpDocumentorについて - AOWP (Aspect-Oriented Web Programming) Wiki - AOWP (Aspect-Oriented Web Pr...

PhpDocumentorについて

AOWPのドキュメントの整理をPhpDocumentorを使おうと思います。

PhpDocumentorには、Javadocみたいな機能に加えて、チュートリアル等も記載する機能がついてます。 この機能を使って、pointcut、join point等の説明を、対応するパッケージのチュートリアルとして記載しようと思います。

パッケージのチュートリアルは、develop/documents/tutorialsに、.pkgの拡張子を付けて、Book docのXML形式で記載しようと思います。 PhpDocumentorが生成したドキュメントの、aowpパッケージにチュートリアルを追加して行こうと思います。 Book docのタイトルがメニューに表示されるので、ドキュメントを書く人は、適当な名前で記述して下さい。

なお、Book docの書き方は、

• PhpDocumentorのドキュメント
• オーライリーのドキュメント
• PEARのドキュメント

を参考にして下さい。

なお、develop/documents/tutorials/aowp/sample.pkgに、PhpDocumentorのクイックスタートのBook docを抜粋したのを置いてますので、参考にして下さい。

あと、外部のPHPファイルをBook docに取り込むことができるのですが、それらの外部ファイルの配置場所を、develop/documents/examplesとしてるので、このフォルダに使用する外部ファイルを置き、Book doc内で相対パスで参照して下さい。