Jump to content

Manual:mwdocgen.php

From mediawiki.org
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 73% complete.

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 to call graph generation.

使用法

php maintenance/run MWDocGen [<オプション>] [<引数 (省略可能)>]

MediaWiki バージョン 1.39.15 以前では、メンテナンス スクリプトを php maintenance/run.php スクリプト名 ではなく php maintenance/スクリプト名.php を使用して実行する必要があります。
オプション/パラメーター 説明
--all 処理するコードベース全体を処理する
MediaWiki バージョン:
1.21
--doxygen Path to doxygen.
MediaWiki バージョン:
1.22
--includes includes/ ディレクトリ内のファイルのみを処理する。
MediaWiki バージョン:
1.21
--languages languages/ ディレクトリ内のファイルのみを処理する。
MediaWiki バージョン:
1.21
--maintenance maintenance/ ディレクトリ内のファイルのみを処理する。
MediaWiki バージョン:
1.21
--extensions extensions/ ディレクトリ内のファイルのみを処理する。
MediaWiki バージョン:
1.34
--skins skins/ ディレクトリ内のファイルのみを処理する。
MediaWiki バージョン:
1.34
--file <file> 指定したファイルのみを処理する。
--no-extensions Process everything but extensions/ directories.
MediaWiki バージョン:
1.33
--output <dir> Set output directory (default $doxyOutput).
--generate-man マニュアルページの文書を生成する
MediaWiki バージョン:
1.33
--help ヘルプを表示して終了します。

関連項目