Handleiding:Mwdocgen.php

MediaWiki bestand: mwdocgen.php
Locatie:	maintenance/
Broncode:	master • 1.46.0 • 1.45.4 • 1.43.9
Classes:	MWDocGen

mwdocgen.php is een MediaWiki onderhoudsscript voor het genereren van class en bestandsreferentie documentatie voor de MediaWiki met gebruik van doxygen. Als de DOT-taalverwerker beschikbaar is, wordt er geprobeerd een grafiek te maken.

Gebruik

php maintenance/run MWDocGen [<opties>] [<argument (optioneel)>]

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

Opties/Parameter	Beschrijving
--all	Verwerk alle code.	MediaWiki-versie: ≤ 1.21
--doxygen	Pad naar doxygen.	MediaWiki-versie: ≥ 1.22
--includes	Verwerk alleen bestanden in de map includes/	MediaWiki-versie: ≤ 1.21
--languages	Verwerk alleen bestanden in de map languages/	MediaWiki-versie: ≤ 1.21
--maintenance	Verwerk alleen bestanden in de map maintenance/	MediaWiki-versie: ≤ 1.21
--extensions	Verwerk alleen bestanden in de map extensions/	MediaWiki-versie: ≥ 1.34
--skins	Verwerk alleen bestanden in de map skins/	MediaWiki-versie: ≥ 1.34
--file <file>	Verwerk alleen het gegeven bestand
--no-extensions	Verwerk alles behalve mappen extensions/.	MediaWiki-versie: ≤ 1.33
--output <dir>	Stel map voor uitvoer in (standaard $doxyOutput).
--generate-man	Maakt handboek documentatie	MediaWiki-versie: ≤ 1.33
--help	Toont de help

Zie ook

• Conventies coderen voor commentaar en documentatie