ASDoc の使用 -- Flex 2.01 にあれこれ載っている。
いつもはこんな感じのDOSバッチファイルを作っておいて asdoc を実行している。
set PATH=%PATH%;C:\flex\bin
asdoc^
-doc-sources=hogelibrary\src^
-output=asdoc^
-compiler.strict=false^
-compiler.show-actionscript-warnings=false^
-main-title="HogeLibrary API Documentation"^
-window-title="HogeLibrary API Documentation"
Flex 2.0.1 SDK の bin ディレクトリにパスを通してから asdoc コマンドを実行。
-doc-sources でソースコードの場所を指定。
-output は API ドキュメントの出力場所。
-main-title と -window-title は API ドキュメントのHTMLに埋め込まれるタイトル。
-compiler.strict=false と -compiler.show-actionscript-warnings=false は厳密な型チェック等をしない設定。
以下、asdoc のヘルプ出力。
C:\>asdoc -help
Adobe Flex Compiler (asdoc)
Version 2.0.1 build 155542
Copyright (c) 2004-2006 Adobe Systems, Inc. All rights reserved.
-help [keyword] [...]
コマンドラインシンタックスの情報および設定変数の説明については、検索ストリングまたは次のいずれかの特別なキーワードを指定します :
syntax - コマンドラインの一般的なシンタックスを説明します
list - すべての基本的な設定変数を一覧表示します
advanced - 高度な設定変数を検索します
aliases - 変数の短いエイリアスを使用してソートします
details - 各アイテムの完全な詳細を常に表示します
その他のヘルプキーワードは、完全または部分的に一致する設定変数、エイリアス、設定変数の説明内に含まれるテキストの検索に使用されます。
例えば、'-help advanced aliases foo' と入力すると、'foo'
というテキストを含むすべての設定オプション(基本および高度の両方)がエイリアス名順にソートされて表示されます。
個別の設定変数の説明では、必須の値は山カッコで示され、オプション値は角カッコで示されます。[...]
は、値が任意の長さのリストであることを示すために使われます。
C:\>asdoc -help list advance
Adobe Flex Compiler (asdoc)
Version 2.0.1 build 155542
Copyright (c) 2004-2006 Adobe Systems, Inc. All rights reserved.
-benchmark
パフォーマンスベンチマークを出力します
-compiler.accessible
エイリアス -accessible
アクセス可能な SWF を生成します
-compiler.actionscript-file-encoding <string>
エイリアス -actionscript-file-encoding
ActionScript ファイルのエンコーディングを指定します。AS3 ソースファイルに BOM
がない場合、コンパイラはこのファイルエンコーディングを使用します。
-compiler.context-root <context-path>
エイリアス -context-root
サービスチャンネルのエンドポイントの {context.root} トークンを置き換えるパス
-compiler.debug
エイリアス -debug
デバッグに適したムービーを生成します
-compiler.external-library-path [path-element] [...]
エイリアス -external-library-path
コンパイル対象であるが、リンクからは除外される SWC ファイルまたはディレクトリの一覧 (反復可能)
-compiler.fonts.flash-type
エイリアス -flash-type
埋め込みフォントの FlashType を有効にして、小さいフォントを見やすくする
-compiler.fonts.max-glyphs-per-face <string>
エイリアス -max-glyphs-per-face
各フォントについてサーバーにキャッシュできる文字のグリフアウトラインの最大数を設定します。デフォルト値は 1000 です。
-compiler.include-libraries [library] [...]
エイリアス -include-libraries
SWF に完全にインクルードされるライブラリ (SWC) の一覧 (反復可能)
-compiler.incremental
エイリアス -incremental
インクリメンタルコンパイルを有効にします
-compiler.library-path [path-element] [...]
エイリアス -l
SWC ファイルまたは SWC ファイルを格納するディレクトリの一覧 (反復可能)
-compiler.locale <string>
エイリアス -locale
国際化用にロケールを指定します
-compiler.namespaces.namespace <uri> <manifest>
エイリアス -namespace
MXML エレメントとして使用するためのコンポーネントのマニフェストに関連付ける URI を指定します (反復可能)
-compiler.optimize
エイリアス -optimize
リンク後の SWF の最適化を有効にします
-compiler.services <filename>
エイリアス -services
Flex データサービス設定ファイルへのパス
-compiler.show-actionscript-warnings
エイリアス -show-actionscript-warnings
有効であるが部分的に正しくないコードを検出するモードで AS3 コンパイラを実行します
-compiler.show-binding-warnings
エイリアス -show-binding-warnings
データバインディングコードから生成される警告を表示するかどうかを切り替えます
-compiler.show-deprecation-warnings
エイリアス -show-deprecation-warnings
推奨されない API を使用した場合に警告を表示するかどうかを切り替えます
-compiler.show-unused-type-selector-warnings
エイリアス -show-unused-type-selector-warnings
使用されていないタイプセレクタから生成される警告を表示するかどうかを切り替える
-compiler.source-path [path-element] [...]
エイリアス -sp
ActionScript クラス階層のルートを形成するパスエレメントの一覧 (反復可能)
-compiler.strict
エイリアス -strict
厳密なエラーチェックモードで AS3 コンパイラを実行します
-compiler.theme [filename] [...]
エイリアス -theme
テーマとして適用する CSS または SWC ファイルの一覧 (反復可能)
-compiler.use-resource-bundle-metadata
エイリアス -use-resource-bundle-metadata
リソースバンドルがアプリケーションに含まれているかどうかを調べます。
-doc-classes [class] [...]
エイリアス -dc
(反復可能, デフォルトの変数)
-doc-namespaces [uri] [...]
エイリアス -dn
(反復可能)
-doc-sources [path-element] [...]
エイリアス -ds
(反復可能)
-exclude-classes [class] [...]
(反復可能)
-exclude-dependencies
-footer <string>
-help [keyword] [...]
キーワードは 'syntax','list','advanced','aliases','details',または検索語句です
-left-frameset-width <int>
-licenses.license <product> <serial-number>
エイリアス -license
specifies a product and a serial number. (反復可能)
-load-config <filename>
設定オプションを含むファイルをロードします (反復可能)
-main-title <string>
-metadata.contributor <name>
エイリアス -contributor
SWF メタデータに保存されている投稿者の名前 (反復可能)
-metadata.creator <name>
エイリアス -creator
SWF メタデータに保存されている作成者の名前 (反復可能)
-metadata.date <text>
エイリアス -date
SWF メタデータに保存されている作成日
-metadata.description <text>
エイリアス -description
SWF メタデータに保存されているデフォルトの説明
-metadata.language <code>
エイリアス -language
SWF メタデータに保存されている言語 (EN、FR など) (反復可能)
-metadata.localized-description <text> <lang>
エイリアス -localized-description
SWF メタデータに保存されているローカライズされた RDF/XMP の説明 (反復可能)
-metadata.localized-title <title> <lang>
エイリアス -localized-title
SWF メタデータに保存されているローカライズされた RDF/XMP タイトル (反復可能)
-metadata.publisher <name>
エイリアス -publisher
SWF メタデータに保存されている発行者の名前 (反復可能)
-metadata.title <text>
エイリアス -title
SWF メタデータに保存されているデフォルトのタイトル
-output <filename>
エイリアス -o
作成する SWF ムービーのファイル名
-packages.package <string> <string>
エイリアス -package
(反復可能)
-runtime-shared-libraries [url] [...]
エイリアス -rsl
アプリケーションが起動する前にロードされるランタイム共有ライブラリの URL の一覧 (反復可能)
-templates-path <string>
-use-network
ネットワークリソースへのアクセスについて SWF にフラグを設定するかどうかを切り替えます
-version
プログラムのビルドバージョンを表示します
-window-title <string>
tags: zlashdot Flash Flash Flex
Posted by NI-Lab. (@nilab)