Manual:mwdocgen.php

MediaWiki file: mwdocgen.php
Location:	maintenance/
Source code:	master • 1.41.1 • 1.40.3 • 1.39.7
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 call graph generation.

Usage

php mwdocgen.php [<command>] [<options>]

Option/Parameter	Description
--all	Process entire codebase.
--includes	Process only files in includes/ directory.
--languages	Process only files in languages/ directory.
--maintenance	Process only files in maintenance/ directory.
--skins	Process only files in skins/ directory.
--files <file>	Process only the given file.
--no-extensions	Process everything but extensions directories.
--output <dir>	Set output directory (default $doxyOutput).
--generate-man	Generates manual page documentation.
--help	Shows the help and exit.

Known bugs

• 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.

See also

• Coding conventions/PHP#Comments and Documentation