Manual:mwdocgen.php

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 80% complete.

Other languages:
Deutsch • ‎English • ‎dansk • ‎español • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎العربية • ‎മലയാളം • ‎ไทย • ‎中文 • ‎日本語

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.

Uso

php mwdocgen.php [<comando>] [<opciones>]
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