Manual:mwdocgen.php

MediaWiki ファイル: mwdocgen.php
場所:	maintenance/
ソース コード:	master • 1.42.3 • 1.41.4 • 1.39.10
クラス:	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 mwdocgen.php [<command>] [<オプション>]

オプション/パラメーター	説明
--all	Process entire codebase.
--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	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.

関連項目

• Coding conventions/PHP#Comments and Documentation