Manual:mwdocgen.php

Archivo de MediaWiki: mwdocgen.php
Ubicación:	maintenance/
Código fuente:	master • 1.41.1 • 1.40.3 • 1.39.7
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 call graph generation.

Uso

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

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

Problemas conocidos

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

Véase también

• Coding conventions/PHP#Comments and Documentation