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.
Verwendung
php maintenance/run MWDocGen [<Optionen>] [<argument (optional) >]
In MediaWiki version
1.39.13 and earlier, you must invoke maintenance scripts using
php maintenance/scriptName .php instead of
php maintenance/run.php scriptName .
Option/Parameter
Beschreibung
--all
Process entire codebase.
MediaWiki Version:
≤ 1.21
--doxygen
Path to doxygen.
MediaWiki Version:
≥ 1.22
--includes
Process only files in includes/ directory.
MediaWiki Version:
≤ 1.21
--languages
Process only files in languages/ directory.
MediaWiki Version:
≤ 1.21
--maintenance
Process only files in maintenance/ directory.
MediaWiki Version:
≤ 1.21
--extensions
Process only files in extensions/ directory.
MediaWiki Version:
≥ 1.34
--skins
Process only files in skins/ directory.
MediaWiki Version:
≥ 1.34
--file <file>
Process only the given file.
--no-extensions
Process everything but extensions/ directories.
MediaWiki Version:
≤ 1.33
--output <dir>
Set output directory (default $doxyOutput).
--generate-man
Generates manual page documentation.
MediaWiki Version:
≤ 1.33
--help
Shows the help and exit.
Siehe auch
