3 * Generate class and file reference documentation for MediaWiki using doxygen.
5 * If the dot DOT language processor is available, attempt call graph
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 * http://www.gnu.org/copyleft/gpl.html
28 * @ingroup Maintenance
30 * @author Antoine Musso <hashar at free dot fr>
31 * @author Brion Vibber
32 * @author Alexandre Emsenhuber
33 * @version first release
36 require_once __DIR__
. '/Maintenance.php';
39 * Maintenance script that builds doxygen documentation.
40 * @ingroup Maintenance
42 class MWDocGen
extends Maintenance
{
45 * Prepare Maintenance class
47 public function __construct() {
48 parent
::__construct();
49 $this->mDescription
= 'Build doxygen documentation';
51 $this->addOption( 'doxygen',
54 $this->addOption( 'version',
55 'Pass a MediaWiki version',
57 $this->addOption( 'generate-man',
58 'Whether to generate man files' );
59 $this->addOption( 'file',
60 'Only process given file (relative to $IP)',
62 $this->addOption( 'output',
63 'Path to write doc to',
65 $this->addOption( 'no-extensions',
66 'Ignore extensions' );
69 public function getDbType() {
70 return Maintenance
::DB_NONE
;
73 protected function init() {
76 $this->doxygen
= $this->getOption( 'doxygen', 'doxygen' );
77 $this->mwVersion
= $this->getOption( 'version', 'master' );
78 $this->input
= $IP . '/' . $this->getOption( 'file', '' );
79 $this->output
= $this->getOption( 'output', "$IP/docs" );
81 $this->inputFilter
= wfShellWikiCmd(
82 $IP . '/maintenance/mwdoc-filter.php' );
83 $this->template
= $IP . '/maintenance/Doxyfile';
84 $this->excludes
= array(
89 $this->excludePatterns
= array();
90 if ( $this->hasOption( 'no-extensions' ) ) {
91 $this->excludePatterns
[] = 'extensions';
94 $this->doDot
= `which dot`
;
95 $this->doMan
= $this->hasOption( 'generate-man' );
98 public function execute() {
103 # Build out directories we want to exclude
105 foreach ( $this->excludes
as $item ) {
106 $exclude .= " $IP/$item";
109 $excludePatterns = implode( ' ', $this->excludePatterns
);
111 $conf = strtr( file_get_contents( $this->template
),
113 '{{OUTPUT_DIRECTORY}}' => $this->output
,
114 '{{STRIP_FROM_PATH}}' => $IP,
115 '{{CURRENT_VERSION}}' => $this->mwVersion
,
116 '{{INPUT}}' => $this->input
,
117 '{{EXCLUDE}}' => $exclude,
118 '{{EXCLUDE_PATTERNS}}' => $excludePatterns,
119 '{{HAVE_DOT}}' => $this->doDot ?
'YES' : 'NO',
120 '{{GENERATE_MAN}}' => $this->doMan ?
'YES' : 'NO',
121 '{{INPUT_FILTER}}' => $this->inputFilter
,
125 $tmpFile = tempnam( wfTempDir(), 'MWDocGen-' );
126 if ( file_put_contents( $tmpFile, $conf ) === false ) {
127 $this->error( "Could not write doxygen configuration to file $tmpFile\n",
128 /** exit code: */ 1 );
131 $command = $this->doxygen
. ' ' . $tmpFile;
132 $this->output( "Executing command:\n$command\n" );
135 system( $command, $exitcode );
137 $this->output( <<<TEXT
138 ---------------------------------------------------
139 Doxygen execution finished.
140 Check above for possible errors.
142 You might want to delete the temporary file:
144 ---------------------------------------------------
149 if ( $exitcode !== 0 ) {
150 $this->error( "Something went wrong (exit: $exitcode)\n",
158 $maintClass = 'MWDocGen';
159 require_once RUN_MAINTENANCE_IF_MAIN
;