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 [<command>] [<options>]

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

Known bugsEdit

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

Language: English