Manual:Mwdocgen.php/zh

Category:MediaWiki code/zh#Mwdocgen.php

mwdocgen.php is a MediaWiki maintenance script that generates class and file reference documentation for MediaWiki using doxygen.

If the DOT language processor is available, attempt call graph generation.

用法

php maintenance/run.php mwdocgen [<指令>] [<选项>]
In MediaWiki version 1.39.12 and earlier, you must invoke maintenance scripts using php maintenance/scriptName.php instead of php maintenance/run.php scriptName.
选项/参数描述
--all处理整个代码库。
--includes仅处理includes/目录中的文件。
--languages仅处理languages/目录中的文件。
--maintenance仅处理maintenance/目录中的文件。
--skins仅处理skins/目录中的文件。
--files <file>仅处理给定的文件。
--no-extensions处理除扩展目录以外的所有内容。
--output <dir>设置输出目录(默认$doxyOutput)。
--generate-man生成手册页文档。
--help显示帮助并退出。

已知错误

  • pass_thru似乎总是使用缓冲(即使使用 ob_implicit_flush()),这使得 doxygen 解析语言文件时输出变慢。
  • 菜单不起作用; 它在修订版 13740 中被禁用。我们需要对其进行编码。

参见

Category:Maintenance scripts/zh#mwdocgen.php Category:Development maintenance scripts/zh
Category:Development maintenance scripts/zh Category:Maintenance scripts/zh Category:MediaWiki code/zh