Kézikönyv:mwdocgen.php

This page is a translated version of the page Manual:Mwdocgen.php and the translation is 68% 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 call graph generation.

Használat

php mwdocgen.php [<parancs>] [<beállítások>]
Beállítás/Paraméter Leírás
--all A teljes kódbázis feldolgozása.
--includes Csak az includes/ könyvtár fájljainak feldolgozása.
--languages Csak a languages/ könyvtár fájljainak feldolgozása.
--maintenance Csak a maintenance/ könyvtár fájljainak feldolgozása.
--skins Csak a skins/ könyvtár fájljainak feldolgozása.
--files <file> Csak az adott fájl feldolgozása.
--no-extensions A kiterjesztéskönyvtárak kivételével minden feldolgozása.
--output <dir> Set output directory (default $doxyOutput).
--generate-man Generates manual page documentation.
--help Shows the help and exit.

Ismert hibák

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

Lásd még