Manual:mwdocgen.php
| MediaWiki file: mwdocgen.php | |
|---|---|
| Location: | maintenance/ |
| Source code: | master • 1.42.4 • 1.41.5 • 1.39.11 |
| 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
[edit]php maintenance.run.php mwdocgen [<command>] [<options>]
In MediaWiki version 1.39.10 and earlier, you must invoke maintenance scripts using
php maintenance/scriptName.php instead of php maintenance/run.php scriptName.| 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
[edit]pass_thruseems to always use buffering (even withob_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.