FlashDevelopからASDoc作成


公開するライブラリはもちろんのこと、非公開であっても複数人で作りこむときや、一人でも長期間にわたってメンテをしないといけない時には、ASDocを生成しておくとよい。でも、FlashDevelopについているジェネレーターの使い方をよく忘れるのでまとめてみた。

そもそもASDocのジェネレーターを使ったこと無い人は次のサイトを見ると良い。

FlashDevelopでASDoc作成 | kudox.jp

FlashDevelopでASDocを作る方法+SVNでASDocを公開する方法の解説ビデオ | ClockMaker Blog

FlashDevelop3 RC3 から ASDoc を書き出すメモ – blog.naggg.jp

Adobe Flex 4.6 * Using the ASDoc tool

上記サイトを参考にしつつも、除外したいライブラリ類がある場合に思い通り動かなくて5時間くらいつぶしてしまう人によるメモ。

FlashDevelop上でASDocからは除外したいクラスは次だったとする。

ファイルのパス類を設定する(このジェネレーターはFlashDevelop本体とは独立しているので、パス類は指定しないといけない)。

ASDocのありかを指定したりだとか。

上手く作成できるとこんなかんじ。

ブラウザで開くとこんなかんじ。やったできた!

とりあえずの目的は達成できたんだけど、swc化してないライブラリ(上の構成で言えば、libの中のcityパッケージ)のクラスを一括して除外指定する方法がわからなかった。

誰か教えてください。

でも、たぶん次は5時間も試行錯誤しない!5分でできるはず!

◆おまけ
asdoc のヘルプ出力(-help list details)

-accessible
フルネーム -compiler.accessible
アクセス可能な SWF を生成します
-actionscript-file-encoding <string>
フルネーム -compiler.actionscript-file-encoding
ActionScript ファイルのエンコーディングを指定します。AS3 ソースファイルに BOM
がない場合、コンパイラーはこのファイルエンコーディングを使用します。
-advanced-anti-aliasing
フルネーム -compiler.fonts.advanced-anti-aliasing
埋め込みフォントの高度なアンチエイリアスを有効にして、小さいフォントを見やすくします。
-benchmark
パフォーマンスベンチマークを出力します
-compatibility-version <version>
フルネーム -compiler.mxml.compatibility-version
互換性のあるバージョンを指定します (compatibility-version=2.0.1 など)
-compiler.mxml.minimum-supported-version <string>
-compress
フルネーム -compiler.compress
-context-root <context-path>
フルネーム -compiler.context-root
サービスチャンネルのエンドポイントの {context.root} トークンを置き換えるパス
-contributor <name>
フルネーム -metadata.contributor
SWF メタデータに保存されている投稿者の名前 (反復可能)
-creator <name>
フルネーム -metadata.creator
SWF メタデータに保存されている作成者の名前 (反復可能)
-date <text>
フルネーム -metadata.date
SWF メタデータに保存されている作成日
-date-in-footer
フッターに日付を含めるかどうかを指定します。
-dc [class] […]
フルネーム -doc-classes
ドキュメントに含めるクラスの一覧。 (反復可能)
-debug
フルネーム -compiler.debug
デバッグに適したムービーを生成します
-description <text>
フルネーム -metadata.description
SWF メタデータに保存されているデフォルトの説明
-dn [uri] […]
フルネーム -doc-namespaces
ドキュメントに含める名前空間の一覧。 (反復可能)
-ds [path-element] […]
フルネーム -doc-sources
ドキュメントに含めるソースファイルの一覧。 (反復可能)
-enable-runtime-design-layers
フルネーム -compiler.enable-runtime-design-layers
-examples-path <string>
サンプルファイルを検索するパス。
-exclude-classes [class] […]
ドキュメントから除外するクラスの一覧。 (反復可能)
-exclude-dependencies
依存関係を除外するかどうかを指定するブール。
-exclude-sources [path-element] […]
ドキュメントから除外するソースファイルの一覧。 (反復可能)
-extension [extension] [parameters] […]
フルネーム -compiler.extensions.extension
(反復可能)
-external-library-path [path-element] […]
フルネーム -compiler.external-library-path
コンパイル対象であるが、リンクからは除外される SWC ファイルまたはディレクトリの一覧 (反復可能)
-flash-type
フルネーム -compiler.fonts.flash-type
埋め込みフォントの FlashType を有効にして、小さいフォントを見やすくする
-footer <string>
ドキュメントに表示するフッター文字列。
-framework <string>
-help [keyword] […]
キーワードは ‘syntax’,’list’,’advanced’,’aliases’,’details’,または検索語句です
-include-all-for-asdoc
-include-libraries [library] […]
フルネーム -compiler.include-libraries
SWF に完全にインクルードされるライブラリ (SWC) の一覧 (反復可能)
-incremental
フルネーム -compiler.incremental
インクリメンタルコンパイルを有効にします
-l [path-element] […]
フルネーム -compiler.library-path
SWC ファイルまたは SWC ファイルを格納するディレクトリの一覧 (反復可能)
-language <code>
フルネーム -metadata.language
SWF メタデータに保存されている言語 (EN、FR など) (反復可能)
-left-frameset-width <int>
左フレームの幅。
-lenient
適格な形式の HTML エラーを警告として報告します。
-license <product> <serial-number>
フルネーム -licenses.license
製品とシリアル番号を指定します。 (反復可能)
-load-config <filename>
設定オプションを含むファイルをロードします (反復可能)
-locale [locale-element] […]
フルネーム -compiler.locale
国際化用にロケールを指定します (反復可能)
-localized-description <text> <lang>
フルネーム -metadata.localized-description
SWF メタデータに保存されているローカライズされた RDF/XMP の説明 (反復可能)
-localized-title <title> <lang>
フルネーム -metadata.localized-title
SWF メタデータに保存されているローカライズされた RDF/XMP タイトル (反復可能)
-main-title <string>
タイトルバーに表示するタイトル。
-max-glyphs-per-face <string>
フルネーム -compiler.fonts.max-glyphs-per-face
各フォントについてサーバーにキャッシュできる文字のグリフアウトラインの最大数を設定します。デフォルト値は 1000 です。
-minimum-supported-version <string>
フルネーム -compiler.minimum-supported-version
-mobile
フルネーム -compiler.mobile
ターゲットランタイムがモバイルデバイスであることを指定します
-namespace [uri] [manifest] […]
フルネーム -compiler.namespaces.namespace
MXML エレメントとして使用するためのコンポーネントのマニフェストに関連付ける URI を指定します (反復可能)
-o <filename>
フルネーム -output
作成する SWF ムービーのファイル名
-omit-trace-statements
フルネーム -compiler.omit-trace-statements
trace ステートメントを省略するかどうかを切り替えます
-optimize
フルネーム -compiler.optimize
リンク後の SWF の最適化を有効にします
-package <string> <string>
フルネーム -packages.package
パッケージ名の説明を指定します。 (反復可能)
-package-description-file <string>
パッケージの説明を含むファイル。
-preloader <string>
フルネーム -compiler.preloader
アプリケーションのプリローダー属性のデフォルト値を指定します。指定しない場合、デフォルトのプリローダー値は、-compatibility-version
アプリケーションのプリローダー属性のデフォルト値を指定します。指定しない場合、デフォルトのプリローダー値は、-compatibility-version >=
>= 4.0 のときに mx.preloaders.SparkDownloadProgressBar
となり、-compatibility-version < 4.0 のときに
mx.preloaders.DownloadProgressBar となります。
-publisher <name>
フルネーム -metadata.publisher
SWF メタデータに保存されている発行者の名前 (反復可能)
-report-invalid-styles-as-warnings
フルネーム -compiler.report-invalid-styles-as-warnings
無効なスタイルを警告として報告します
-rsl [url] […]
フルネーム -runtime-shared-libraries
アプリケーションが起動する前にロードされるランタイム共有ライブラリの URL の一覧 (反復可能)
-rslp [path-element] [rsl-url] [policy-file-url] [rsl-url] [policy-file-url]
フルネーム -runtime-shared-library-path
リンクする SWC、読み込む RSL URL、ポリシーファイル URL (オプション) およびフェイルオーバー URL (オプション)
を指定します (反復可能)
-services <filename>
フルネーム -compiler.services
Flex データサービス設定ファイルへのパス
-show-actionscript-warnings
フルネーム -compiler.show-actionscript-warnings
有効であるが部分的に正しくないコードを検出するモードで AS3 コンパイラーを実行します
-show-binding-warnings
フルネーム -compiler.show-binding-warnings
データバインディングコードから生成される警告を表示するかどうかを切り替えます
-show-invalid-css-property-warnings
フルネーム -compiler.show-invalid-css-property-warnings
無効な CSS プロパティに関する警告を報告するかどうかを切り替えます
-show-shadowed-device-font-warnings
フルネーム -compiler.show-shadowed-device-font-warnings
埋め込みフォント名がデバイスフォント名に影響する場合に、警告を表示するかどうかを切り替えます
-show-unused-type-selector-warnings
フルネーム -compiler.show-unused-type-selector-warnings
使用されていない CSS タイプセレクターから生成される警告を表示するかどうかを切り替えます
-sp [path-element] […]
フルネーム -compiler.source-path
ActionScript クラス階層のルートを形成するパスエレメントの一覧 (反復可能)
-static-rsls
フルネーム -static-link-runtime-shared-libraries
ドメイン間の rsl によって指定されたライブラリを静的にリンクします。
-strict
フルネーム -compiler.strict
厳密なエラーチェックモードで AS3 コンパイラーを実行します
-swf-version <int>
コンパイル済 SWF ファイルのバージョンを指定します。
-target-player <version>
アプリケーションがターゲットとするプレーヤーのバージョンを指定します。より新しいバージョンを必要とする機能は、アプリケーションにコンパイルされません。サポートされる最小の値は「9.0.0」です。
-templates-path <string>
カスタムテンプレートのパス。
-theme [filename] […]
フルネーム -compiler.theme
テーマとして適用する CSS または SWC ファイルの一覧 (反復可能)
-title <text>
フルネーム -metadata.title
SWF メタデータに保存されているデフォルトのタイトル
-tools-locale <string>
エラーと警告を通知する際にコンパイラーで使用するロケールを指定します。
-use-direct-blit
アクセラレーションを使用できる場合は、画面へのグラフィックの転送にハードウェアアクセラレーションを使用します。
-use-gpu
アクセラレーションを使用できる場合は、グラフィックの描画時に GPU コンポジット機能を使用します。
-use-network
ネットワークリソースへのアクセスについて SWF にフラグを設定するかどうかを切り替えます
-use-resource-bundle-metadata
フルネーム -compiler.use-resource-bundle-metadata
リソースバンドルがアプリケーションに含まれているかどうかを調べます。
-verbose-stacktraces
フルネーム -compiler.verbose-stacktraces
デバッグ用にコールスタック情報を SWF に保存します
-version
プログラムのビルドバージョンを表示します
-warnings
警告の表示を切り替えます
-window-title <string>
ブラウザーウィンドウに表示するタイトル。