Manual:mwdocgen.php

Archivo de MediaWiki: mwdocgen.php
Ubicación:	maintenance/
Código fuente:	master • 1.44.2 • 1.43.5 • 1.39.15
Clases:	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.

Uso

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

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

Opción/parámetro	Descripción
--all	Process entire codebase. Versión de MediaWiki: ≤ 1.21
--doxygen	Path to doxygen. Versión de MediaWiki: ≥ 1.22
--includes	Procesar sólo los archivos en el directorio includes/ Versión de MediaWiki: ≤ 1.21
--languages	Procesar sólo los archivos en el directorio languages/ Versión de MediaWiki: ≤ 1.21
--maintenance	Procesar sólo los archivos en el directorio maintenance/ Versión de MediaWiki: ≤ 1.21
--extensions	Process only files in extensions/ directory. Versión de MediaWiki: ≥ 1.34
--skins	Procesar sólo los archivos en el directorio skins/ Versión de MediaWiki: ≥ 1.34
--file <file>	Procesar sólo los archivos dados.
--no-extensions	Procesar todo excepto los directorios de extensiones. Versión de MediaWiki: ≤ 1.33
--output <dir>	Establecer el directorio de salida (por omisión $doxyOutput).
--generate-man	Genera documentación de páginas manuales. Versión de MediaWiki: ≤ 1.33
--help	Muestra la ayuda y sale.

Véase también

• Coding conventions/PHP#Comments and Documentation