Jump to content

Руководство:Mwdocgen.php

From mediawiki.org
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 14% complete.

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)>]

В MediaWiki версии 1.43.6 и ранее скрпиты обслуживания нужно вызывать через php maintenance/scriptName.php, а не через php maintenance/run.php scriptName.
Option/Parameter Описание
--all Process entire codebase.
Версия MediaWiki:
1.21
--doxygen Path to doxygen.
Версия MediaWiki:
1.22
--includes Process only files in includes/ directory.
Версия MediaWiki:
1.21
--languages Process only files in languages/ directory.
Версия MediaWiki:
1.21
--maintenance Process only files in maintenance/ directory.
Версия MediaWiki:
1.21
--extensions Process only files in extensions/ directory.
Версия MediaWiki:
1.34
--skins Process only files in skins/ directory.
Версия MediaWiki:
1.34
--file <file> Process only the given file.
--no-extensions Process everything but extensions/ directories.
Версия MediaWiki:
1.33
--output <dir> Set output directory (default $doxyOutput).
--generate-man Generates manual page documentation.
Версия MediaWiki:
1.33
--help Shows the help and exit.

См. также