asdoc クラスライブラリを除外する
BetweenAS3 SoundManager サウンドまとめて管理の asdocを書きだそうとして四苦八苦したメモ。
FlashDevelopでasdocが簡単に書き出せる機能を使いました。
普段使わない人はなかなか気にとめないですよね。。
それで、今回問題になったのは、asdocを書きだそうとした際に、BetweenAS3を一緒に書きださないためのTips
FlashDevelop3 RC3 から ASDoc を書き出すメモ
をみながらサクサクっと簡単にasdocを書き出せたのはいいのですが、
今回作成したような~依存型のクラスファイルをasdocを書きだそうとしたのだけれども、
BetweenAS3も一緒に書き出されてしまいます。
BetweenAS3の文書は書き出さない方法は
SWCじゃないライブラリをフォルダでasdocの対象にならない指定ができたら便利なのに。。
FlashDevelopでasdocが簡単に書き出せる機能を使いました。
普段使わない人はなかなか気にとめないですよね。。
それで、今回問題になったのは、asdocを書きだそうとした際に、BetweenAS3を一緒に書きださないためのTips
FlashDevelop3 RC3 から ASDoc を書き出すメモ
をみながらサクサクっと簡単にasdocを書き出せたのはいいのですが、
今回作成したような~依存型のクラスファイルをasdocを書きだそうとしたのだけれども、
BetweenAS3も一緒に書き出されてしまいます。
BetweenAS3の文書は書き出さない方法は
- Project -> Exclude classes で１つ１つファイルを除外
結果:時間は大切にするべき - Project -> Exclude classes で” * ” 使用してファイルを除外
結果: ” * ” によるファイル指定できず。 - Extra optionsでAdobeの公式ページによると
クラスの除外
doc-classes、doc-sources、および doc-namespaces オプションによって指定されるクラスは、次の例外を除いてすべて文書化されます。
* exclude-classes オプションを使用してクラスを指定した場合は、そのクラスは文書化されません。
* クラスの ASDoc コメントに @private タグが含まれる場合は、そのクラスは文書化されません。
* クラスが SWC で検出されると、そのクラスは文書化されません。さらに、さらに、
コンパイル用として、SWC ファイルとして表されるライブラリファイルをアプリケーションが必要とする場合もあります。次の例では、-library-path オプションを使用して、SWC ファイルが格納されているディレクトリを指定します。
asdoc -source-path . -doc-classes myComponents.BlueButton -library-path C:¥myLibs
明示的にSWCファイルをコンパイルオプションに入れてやれば、文書化されないようになる！！
-library-path を使用してswcのあるフォルダを指定してやるとこうなります。
結果:
SWCじゃないライブラリをフォルダでasdocの対象にならない指定ができたら便利なのに。。
