| Index: trunk/phase3/maintenance/mwdocgen.php |
| — | — | @@ -1,15 +1,13 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * Script to easily generate the mediawiki documentation using doxygen. |
| | 4 | + * Generate class and file reference documentation for MediaWiki using doxygen. |
| 5 | 5 | * |
| 6 | | - * By default it will generate the whole documentation but you will be able to |
| 7 | | - * generate just some parts. |
| | 6 | + * If the dot DOT language processor is available, attempt call graph |
| | 7 | + * generation. |
| 8 | 8 | * |
| 9 | 9 | * Usage: |
| 10 | 10 | * php mwdocgen.php |
| 11 | 11 | * |
| 12 | | - * Then make a selection from the menu |
| 13 | | - * |
| 14 | 12 | * KNOWN BUGS: |
| 15 | 13 | * |
| 16 | 14 | * - pass_thru seems to always use buffering (even with ob_implicit_flush()), |
| — | — | @@ -46,7 +44,7 @@ |
| 47 | 45 | # |
| 48 | 46 | |
| 49 | 47 | if ( php_sapi_name() != 'cli' ) { |
| 50 | | - echo 'Run me from the command line.'; |
| | 48 | + echo 'Run "' . __FILE__ . '" from the command line.'; |
| 51 | 49 | die( -1 ); |
| 52 | 50 | } |
| 53 | 51 | |
| — | — | @@ -63,7 +61,6 @@ |
| 64 | 62 | $svnstat = $mwPath . 'bin/svnstat'; |
| 65 | 63 | |
| 66 | 64 | /** where Phpdoc should output documentation */ |
| 67 | | -# $doxyOutput = '/var/www/mwdoc/'; |
| 68 | 65 | $doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR ; |
| 69 | 66 | |
| 70 | 67 | /** MediaWiki subpaths */ |
| — | — | @@ -145,7 +142,7 @@ |
| 146 | 143 | * @param $currentVersion String: Version number of the software |
| 147 | 144 | * @param $svnstat String: path to the svnstat file |
| 148 | 145 | * @param $input String: Path to analyze. |
| 149 | | - * @param $exclude String: Additionals path regex to exlcude |
| | 146 | + * @param $exclude String: Additionals path regex to exclude |
| 150 | 147 | * (LocalSettings.php, AdminSettings.php, .svn and .git directories are always excluded) |
| 151 | 148 | */ |
| 152 | 149 | function generateConfigFile( $doxygenTemplate, $outputDirectory, $stripFromPath, $currentVersion, $svnstat, $input, $exclude ) { |
| — | — | @@ -160,6 +157,7 @@ |
| 161 | 158 | '{{SVNSTAT}}' => $svnstat, |
| 162 | 159 | '{{INPUT}}' => $input, |
| 163 | 160 | '{{EXCLUDE}}' => $exclude, |
| | 161 | + '{{HAVE_DOT}}' => `which dot` ? 'YES' : 'NO', |
| 164 | 162 | ); |
| 165 | 163 | $tmpCfg = str_replace( array_keys( $replacements ), array_values( $replacements ), $template ); |
| 166 | 164 | $tmpFileName = tempnam( wfTempDir(), 'mwdocgen-' ); |
| Index: trunk/phase3/maintenance/Doxyfile |
| — | — | @@ -255,7 +255,7 @@ |
| 256 | 256 | #--------------------------------------------------------------------------- |
| 257 | 257 | CLASS_DIAGRAMS = NO |
| 258 | 258 | HIDE_UNDOC_RELATIONS = YES |
| 259 | | -HAVE_DOT = NO |
| | 259 | +HAVE_DOT = {{HAVE_DOT}} |
| 260 | 260 | CLASS_GRAPH = YES |
| 261 | 261 | COLLABORATION_GRAPH = YES |
| 262 | 262 | GROUP_GRAPHS = YES |