apigen

apigen --config <path> [options]
apigen --source <path> --destination <path> [options]

ご覧のように、ApiGenを使用するか、コマンドラインを介して単一のパラメータを指定するか、プロファイルを使用することができます.さらに、この2つの方法とコマンドラインパラメータを組み合わせて、プロファイルよりも優先することができます.
各構成オプションが実行する価値.これとまったく同じ書き込みです.構成=ファイル構成とプロファイル構成です.唯一の例外はブールオプションです(それらは|値がありません).これらのオプションを使用してコマンドラインに明確な「はい」価値を提供していない場合.ommitedの場合は、オプションを選択したいと仮定します.したがって、デバッグ=はい、デバッグとまったく同じ(反対ですか--デバッグ=いいえ)を使用します.
いくつかのオプションには複数の値があります.このため、複数または複数の値をカンマで区切ることができます.これは、ソース=file 1を意味します.php-ソース=phpおよび-ソース=file 1.php内ではphpは全く同じです.
オプション

--config|-c <file>

ファイルのパスを設定します.

--source|-s <directory|file> required

パスディレクトリまたはファイルを処理します.パラメータを使用して、リストのディレクトリまたはファイルを複数回提供できます.すべてのタイプのPHARアーカイブのサポート(PHAR拡張が必要).広州/bz 2圧縮ファイルを処理するには、適切な拡張が必要です(需要を参照).

--destination|-d <directory> required

生成されたドキュメントをこのディレクトリに移動します.

--extensions <list>

許可されているファイル拡張子のリストです.デフォルトはphpです.

--exclude <mask>

ディレクトリとファイルが一致するこのファイルマスクは解析されません.例えばテストのような処理を排除することができます.このパラメータは大文字と小文字が敏感で、何度も使用できます.

--skip-doc-path <mask>
--skip-doc-prefix <value>

このパラメータを使用すると、ApiGenにドキュメント要素を生成しないか、名前の接頭辞を生成しないように伝えることができます.これらのコースはクラス樹木に表示されますが、ドキュメントにリンクするものは作成されません.これらのパラメータはすべて大文字と小文字に敏感で、何度も使用できます.

--charset <list>

文字セットのソースファイル、デフォルトは「自動」で、ApiGenにサポートされているすべての文字セットを選択させます.しかし、ソースファイルに1文字しか設定していない場合は、自動的に回避する必要があります(完全に信頼できるわけではありません).また、処理の自動生成ドキュメントを低減します.また、複数のパラメータを使用して、ドキュメントで使用されているすべての文字セットをリストすることもできます.この場合、ApiGenは各ファイルに提供する文字セットを選択します.

--main <value>

この名前の接頭辞の要素は「プライマリ・アイテム」とみなされます(残りはライブラリとみなされます).

--title <value>

生成されたドキュメントのタイトル.

--base-url <value>

ドキュメントの基本URLはサイトマップに使用されます.ドキュメントを公開するつもりなら.

--google-cse-id <value>

Google CSE ID、検索ボックスがある場合は、正確なクラスや関数名に入らない場合は、変更されません.

--google-cse-label <value>

これはデフォルトのラベルがGoogle CSEを使用しています.

--google-analytics <value>

Googleが追跡コードを分析します.ansynchronousトラッキングコードが指定されている場合、生成された各ページにアクセスします.

--template-config <file>

テンプレートプロファイル、デフォルトはプロファイルのApiGenデフォルトテンプレートです.

--allowed-html <list>

許可されているHTMLタグのリストは、ドキュメントでカンマで区切られています.デフォルト値はb、私、1つ、ul、ol、李、リン、臭素、var、トウモロコシ粥、kbd、ttです.

--groups <value>

メニュー要素をどのようにグループ化するか.可能なオプションは、「自動車」、「名前」、「バッグ」、「なし」です.デフォルトは自動(Automatic)です(名前空間を使用する場合はソースコードを使用しない場合はパッケージ).

--autocomplete <list>

要素タイプのリストが検索入力で自動的に完了します.可能な値は、クラス、定数、機能、メソッド、プロパティ、classconstantsです.既定値はクラス、定数、機能です.

--access-levels <list>

アクセスレベルのメソッドとプロパティは、ドキュメントの解析を受ける必要があります.デフォルト値は共通で保護されています(プライベートクラスメンバーは生成されません).

--internal <yes|no>

生成されたドキュメント要素は、内部(@internalは記述していません)と表示部分のドキュメントは内部(@internalは記述と...または{@internal...})としてマークされ、デフォルトは「いいえ」です.

--php <yes|no>

ドキュメントはPHP内部クラスを生成し、デフォルトは「はい」です.

--tree <yes|no>

ツリービュークラス、インタフェース、フィーチャー、例外を生成します.デフォルトは「はい」です.

--deprecated <yes|no>

ドキュメントの破棄要素を生成します.デフォルトは「いいえ」です.

--todo <yes|no>

タスク・リストを生成します.デフォルトは「いいえ」です.

--source-code <yes|no>

生成されたソースコードは、ユーザー定義の要素をハイライト表示します.デフォルトは「はい」です.

--download <yes|no>

ダウンロードドキュメントへのリンクをZIPアーカイブファイルとして追加します.デフォルトは「いいえ」です.

--report <file>

checkstyleレポートにドキュメントが欠けている要素をファイルに保存します.

--wipeout <yes|no>

ファイルを削除して生成されたのは前を走り、デフォルトは「はい」です.

--quiet <yes|no>

コンソールには印刷されません.デフォルトは「いいえ」です.

--progressbar <yes|no>

progressbarによると、デフォルトは「はい」です.

--colors <yes|no>

色を使用して、デフォルトの「いいえ」はWindowsで、「はい」は他のシステムで使用します.ウィンドウの色はコンソールではサポートされていませんが、Ansiconを有効にすることができます.

--update-check <yes|no>

新しいバージョンのApiGenを確認します.デフォルトは「はい」です.

--debug <yes|no>

エラーが発生した場合、デフォルトは「いいえ」です.

--help|-h

リストで使用可能なオプションを表示します.
ソースパラメータと宛先パラメータのみが必要です.コマンドラインまたはプロファイルを使用することができます.
プロファイル
コマンドラインを介して単一のパラメータを指定するのではなく、後で使用するためのプロファイルを用意できます.上にリストされているすべてのパラメータ(例外:構成オプション)を使用できますが、ダッシュと大文字の後のダッシュがないだけです(アクセスレベルはaccessLevelになります).
ApiGenは、すべてのプロファイルをネオンファイル形式で使用します.オンライン解析器でプロファイルをデバッグして、解析方法を見てみましょう.
その後、ApiGenに単一のパラメータで指定したプロファイルのロードを構成するように呼び出すことができます.

apigen --config <path> [options]

プロファイルを使用しても、コマンドラインを通過する追加のパラメータを指定できます.このようなパラメータは、プロファイルのパラメータよりも優先されます.
任意のプロファイルの値がコマンドラインの値から上書きされることを覚えておいてください.これは、ソースパラメータの値がプロファイルにあり、コマンドラインを介してすべての値が使用されることはありませんが、コマンドラインからのみ使用されることを意味します.
コマンドラインパラメータが指定できない場合、ApiGenはapigenというデフォルトプロファイルをロードしようとします.Neonは現在の作業ディレクトリにあります.それが見つかった場合は、使用した場合に設定オプションとして使用されます.コマンドラインオプションを使用する場合は、プロファイルを指定する必要があります.ApiGenは、コマンドラインパラメータがない場合にのみ使用される自動ロードを試みます.
オプション名はcamelCaseでプロファイルにする必要があります(テンプレートはコマンドライン上でtemplateConfigがプロファイルになるように構成されています).完全なリストの構成オプションと短い説明の例の構成ファイルapigenが表示されます.neon.example .
例
ドキュメントを生成しています.クラスツリー、リストの親クラス、およびそのメンバーがリストで継承する属性、メソッド、定数を指定します.しかし、すべてのドキュメントを生成したり、ソースコードをハイライト表示したりすることは望んでいません.クラスがあり、このプロジェクトの実際に属していない可能性があるため、「テスト」ディレクトリを処理する必要はありません.

apigen --source ~/nella/Nella --source ~/doctrine2/lib/Doctrine --source ~/doctrine2/lib/vendor --source ~/nette/Nette --skip-doc-path "~/doctrine2/*" --skip-doc-prefix Nette --exclude "*/tests/*" --destination ~/docs/ --title "Nella Framework"