Manual:mwdocgen.php
Appearance
Outdated translations are marked like this.
Arquivo MediaWiki: mwdocgen.php | |
---|---|
Local: | maintenance/ |
Código fonte: | master • 1.43.0 • 1.42.4 • 1.39.11 |
Classes: | MWDocGen |
O arquivo mwdocgen.php é um script de manutenção do MediaWiki que gera documentação de referência de classes e arquivos para o MediaWiki usando o doxygen. Se o processador de linguagem DOT estiver disponível, tenta chamar a geração de gráfico. If the DOT language processor is available, attempt call graph generation.
Uso
php maintenance.run.php mwdocgen [<command>] [<options>]
In MediaWiki version 1.39.10 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 | Processa toda a base de código. |
--includes | Processa somente os arquivos no diretório includes/. |
--languages | Processa somente os arquivos no diretório languages/. |
--maintenance | Processa somente os arquivos no diretório maintenance/. |
--skins | Processa somente os arquivos no diretório skins/. |
--files <file> | Processa apenas o arquivo especificado. |
--no-extensions | Processa tudo, exceto diretórios de extensões. |
--output <dir> | Define o diretório de saída (o padrão é $doxyOutput ).
|
--generate-man | Gera a documentação da página do manual. |
--help | Exibe a ajuda e é fechado. |
Bugs conhecidos
pass_thru
parece usar sempre o buffer (mesmo com o códigoob_implicit_flush()
), o que torna a saída lenta quando o doxygen analisa arquivos de idiomas.- o menu não funciona; ele foi desabilitado na revisão 13740. Precisamos corrigir o código.