Kézikönyv:mwdocgen.php

MediaWiki-fájl: mwdocgen.php
Könyvtár:	maintenance/
Forráskód:	master • 1.45.1 • 1.44. • 1.39.16
Osztályok:	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.

Használat

php maintenance/run MWDocGen [<beállítások>] [<argument (optional)>]

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

Beállítás/Paraméter	Leírás
--all	A teljes kódbázis feldolgozása. MediaWiki-verzió: ≤ 1.21
--doxygen	Path to doxygen. MediaWiki-verzió: ≥ 1.22
--includes	Csak az includes/ könyvtár fájljainak feldolgozása. MediaWiki-verzió: ≤ 1.21
--languages	Csak a languages/ könyvtár fájljainak feldolgozása. MediaWiki-verzió: ≤ 1.21
--maintenance	Csak a maintenance/ könyvtár fájljainak feldolgozása. MediaWiki-verzió: ≤ 1.21
--extensions	Process only files in extensions/ directory. MediaWiki-verzió: ≥ 1.34
--skins	Csak a skins/ könyvtár fájljainak feldolgozása. MediaWiki-verzió: ≥ 1.34
--file <file>	Csak az adott fájl feldolgozása.
--no-extensions	A kiterjesztéskönyvtárak kivételével minden feldolgozása. MediaWiki-verzió: ≤ 1.33
--output <dir>	Set output directory (default $doxyOutput).
--generate-man	Generates manual page documentation. MediaWiki-verzió: ≤ 1.33
--help	Shows the help and exit.

Lásd még

• Coding conventions/PHP#Comments and Documentation