Manual:Mwdocgen.php

MediaWiki file: mwdocgen.php
Location:	maintenance/
Source code:	master • 1.45.1 • 1.44. • 1.39.16
Classes:	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 to call graph generation.

Usage

php maintenance/run MWDocGen [<options>] [<argument (optional)>]

In MediaWiki version 1.39.16 and earlier, you must invoke maintenance scripts using php maintenance/scriptName.php instead of php maintenance/run.php scriptName.

Option/Parameter	Beskrivelse
--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.

Se også

• Coding conventions/PHP#Comments and Documentation