手册:mwdocgen.php

MediaWiki文件： mwdocgen.php
位置：	maintenance/
源代码：	master • 1.39.1 • 1.38.5 • 1.35.9
类：	MWDocGen

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 mwdocgen.php [<command>] [<options>]

选项/参数	描述
--all	处理整个代码库。
--includes	仅处理includes/目录中的文件。
--languages	仅处理languages/目录中的文件。
--maintenance	仅处理maintenance/目录中的文件。
--skins	仅处理skins/目录中的文件。
--files <file>	仅处理给定的文件。
--no-extensions	处理除扩展目录以外的所有内容。
--output <dir>	Set output directory (default $doxyOutput).
--generate-man	Generates manual page documentation.
--help	Shows the help and exit.

已知错误

• pass_thru seems to always use buffering (even with ob_implicit_flush()), that make output slow when doxygen parses language files.
• the menu doesn't work; it got disabled at revision 13740. We need to code it.

参见

• Coding conventions/PHP#Comments and Documentation