Manual:mwdocgen.php

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 100% complete.

Other languages:
English • ‎dansk • ‎español • ‎polski • ‎português do Brasil • ‎العربية • ‎ไทย • ‎中文 • ‎日本語

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.

Uso

php mwdocgen.php [<comando>] [<opções>]
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ódigo ob_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.

Ver também