Manuel:Mwdocgen.php
| Fichier MediaWiki : mwdocgen.php | |
|---|---|
| Emplacement : | maintenance/ |
| Code source : | master • 1.42.3 • 1.41.4 • 1.39.10 |
| Classes : | MWDocGen |
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 mwdocgen.php [<commande>] [<options>]
| Option/paramètre | Description |
|---|---|
| --all | Traiter toute la base de code. |
| --includes | Ne traiter que les fichiers présents dans le répertoire includes/ . |
| --languages | Ne traiter que les fichiers du répertoire languages/ . |
| --maintenance | Ne traiter que les fichiers du répertoire maintenance/ . |
| --skins | Ne traiter que les fichiers présents dans le répertoire skins/ . |
| --files <file> | Traite uniquement le fichier donné. |
| --no-extensions | Tous traiter sauf les répertoires des extensions. |
| --output <dir> | Initialiser le répertoire de sortie ($doxyOutput par défaut).
|
| --generate-man | Génère la documentation des pages du manuel. |
| --help | Affiche l'aide et se termine. |
Problèmes connus
pass_thrusemble toujours utiliser les tampons (même avecob_implicit_flush()), ce qui ralentit la sortie quand doxygen analyse les fichiers du langage.- le menu ne fonctionne pas; il a été désactivé à la révision 13740. Nous devons le coder.