Manual:mwdocgen.php

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 65% complete.

Other languages:
English • ‎dansk • ‎español • ‎polski • ‎português do Brasil • ‎العربية • ‎ไทย • ‎中文 • ‎日本語

mwdocgen.php is a MediaWiki maintenance script that generates class and file reference documentation for MediaWiki using doxygen. If the dot DOT language processor is available, attempt call graph generation.

使用法

php mwdocgen.php [<コマンド>] [<オプション>]
オプション/パラメーター 説明
--all Process entire codebase.
--includes includes/ ディレクトリ内のファイルのみを処理する。
--languages languages/ ディレクトリ内のファイルのみを処理する。
--maintenance maintenance/ ディレクトリ内のファイルのみを処理する。
--skins skins/ ディレクトリ内のファイルのみを処理する。
--files <file> 指定したファイルのみを処理する。
--no-extensions Process everything but extensions directorys.
--output <dir> Set output directory (default $doxyOutput).
--generate-man Generates manual page documentation.
--help ヘルプを表示して終了します。

既知のバグ

  • pass_thru seems to always use buffering (even with ob_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.

関連項目