Manual:mwdocgen.php
MediaWiki ファイル: mwdocgen.php | |
---|---|
場所: | maintenance/ |
ソース コード: | master • 1.43.0 • 1.42.5 • 1.39.11 |
クラス: | MWDocGen |
mwdocgen.php is a MediaWiki maintenance script that generates class and file reference documentation for MediaWiki using doxygen.
If the DOT language processor is available, attempt call graph generation.
使用法
php maintenance/run.php mwdocgen [<コマンド>] [<オプション>]
MediaWiki バージョン 1.39.10 以前では、メンテナンス スクリプトを
php maintenance/run.php scriptName
ではなく php maintenance/scriptName.php
を使用して実行する必要があります。オプション/パラメーター | 説明 |
---|---|
--all | 処理するコードベース全体を処理する |
--includes | includes/ ディレクトリ内のファイルのみを処理する。 |
--languages | languages/ ディレクトリ内のファイルのみを処理する。 |
--maintenance | maintenance/ ディレクトリ内のファイルのみを処理する。 |
--skins | skins/ ディレクトリ内のファイルのみを処理する。 |
--files <file> | 指定したファイルのみを処理する。 |
--no-extensions | Process everything but extensions directories. |
--output <dir> | Set output directory (default $doxyOutput ).
|
--generate-man | マニュアルページの文書を生成する |
--help | ヘルプを表示して終了します。 |
既知のバグ
pass_thru
seems to always use buffering (even withob_implicit_flush()
), that make output slow when doxygen parses language files.- the menu doesn't work; it got disabled at revision 13740. We need to code it.