Manual:Mwdocgen.php

ficheiro do MediaWiki: mwdocgen.php
Localização:	maintenance/
Código fonte:	master • 1.44.0 • 1.43.3 • 1.39.13
Classes:	MWDocGen

mwdocgen.php é um Guião de manutenção do MediaWiki que produz documentação de referência de classe e ficheiro para o MediaWiki usando doxygen. Se o Processador de linguagem DOT estiver disponível, tente usar o gerador de gráfico.

Utilização

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

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

Opção/Parâmetro	Descrição
--all	Process entire codebase. Versão MediaWiki: ≤ 1.21
--doxygen	Path to doxygen. Versão MediaWiki: ≥ 1.22
--includes	Process only files in includes/ directory. Versão MediaWiki: ≤ 1.21
--languages	Process only files in languages/ directory. Versão MediaWiki: ≤ 1.21
--maintenance	Process only files in maintenance/ directory. Versão MediaWiki: ≤ 1.21
--extensions	Process only files in extensions/ directory. Versão MediaWiki: ≥ 1.34
--skins	Process only files in skins/ directory. Versão MediaWiki: ≥ 1.34
--file <file>	Process only the given file.
--no-extensions	Process everything but extensions/ directories. Versão MediaWiki: ≤ 1.33
--output <dir>	Set output directory (default $doxyOutput).
--generate-man	Generates manual page documentation. Versão MediaWiki: ≤ 1.33
--help	Shows the help and exit.

Ver também

• Coding conventions/PHP#Comments and Documentation