Handleiding:Mwdocgen.php

From mediawiki.org
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 100% complete.


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 mwdocgen.php [<commando>] [<opties>]
Opties/Parameter Beschrijving
--all Verwerk alle code.
--includes Verwerk alleen bestanden in de map includes/
--languages Verwerk alleen bestanden in de map /languages
--maintenance Verwerk alleen bestanden in de map /maintenance
--skins Verwerk alleen bestanden in de map /skins
--files <file> Verwerk alleen het gegeven bestand
--no-extensions Verwerk alles maar niet mappen met extensies
--output <dir> Stel map voor uitvoer in (standaard $doxyOutput).
--generate-man Maakt handboek documentatie
--help Toont de help

Bekende problemen

  • pass_thru schijnt buffering te gebruiken (ook met ob_implicit_flush()), dat maakt dat de uitvoer langzaam is als doxygen taalbestanden verwerkt.
  • het menu werkt niet, het raakte uitgeschakeld bij revisie 13740. Het moet met programmeren worden verholpen.

Zie ook