Jump to content

手册:mwdocgen.php

From mediawiki.org
This page is a translated version of the page Manual:Mwdocgen.php and the translation is 50% complete.
Outdated translations are marked like this.

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 to call graph generation.

用法

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

在MediaWiki 1.39.15 及更早版本中,您必须通过php maintenance/脚本名称.php调用维护脚本,而不是php maintenance/run.php 脚本名称
选项/参数 描述
--all 处理整个代码库。
MediaWiki版本:
1.21
--doxygen Path to doxygen.
MediaWiki版本:
1.22
--includes 仅处理includes/目录中的文件。
MediaWiki版本:
1.21
--languages 仅处理languages/目录中的文件。
MediaWiki版本:
1.21
--maintenance 仅处理maintenance/目录中的文件。
MediaWiki版本:
1.21
--extensions Process only files in extensions/ directory.
MediaWiki版本:
1.34
--skins 仅处理skins/目录中的文件。
MediaWiki版本:
1.34
--file <file> 仅处理给定的文件。
--no-extensions 处理除扩展目录以外的所有内容。
MediaWiki版本:
1.33
--output <dir> 设置输出目录(默认$doxyOutput)。
--generate-man 生成手册页文档。
MediaWiki版本:
1.33
--help 显示帮助并退出。

参阅