Jump to content

Manuel:Mwdocgen.php

From mediawiki.org
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 59% complete.
Outdated translations are marked like this.

mwdocgen.php est un script de maintenance MediaWiki qui génère la documentation de référence pour les classes et les fichiers de MediaWiki en utilisant doxygen. Si le processeur pour le langage DOT est disponible, il essaie aussi de générer le graphe des appels.

Utilisation

php maintenance/run MWDocGen [<options>] [<argument (optional)>]

Dans la version MediaWiki 1.43.6 et antérieures, vous devez appeler les scripts de maintenance en utilisant php maintenance/scriptName.php au lieu de php maintenance/run.php scriptName.
Option/paramètre Description
--all Traiter toute la base de code.
Version de MediaWiki :
1.21
--doxygen Path to doxygen.
Version de MediaWiki :
1.22
--includes Ne traiter que les fichiers présents dans le répertoire includes/ .
Version de MediaWiki :
1.21
--languages Ne traiter que les fichiers du répertoire languages/ .
Version de MediaWiki :
1.21
--maintenance Ne traiter que les fichiers du répertoire maintenance/ .
Version de MediaWiki :
1.21
--extensions Process only files in extensions/ directory.
Version de MediaWiki :
1.34
--skins Ne traiter que les fichiers présents dans le répertoire skins/ .
Version de MediaWiki :
1.34
--file <file> Traite uniquement le fichier donné.
--no-extensions Tous traiter sauf les répertoires des extensions.
Version de MediaWiki :
1.33
--output <dir> Initialiser le répertoire de sortie ($doxyOutput par défaut).
--generate-man Génère la documentation des pages du manuel.
Version de MediaWiki :
1.33
--help Affiche l'aide et se termine.

Voir aussi