<?php
/**
- * Script to easily generate the mediawiki documentation.
+ * Script to easily generate the mediawiki documentation using doxygen.
*
* By default it will generate the whole documentation but you will be able to
* generate just some parts.
*
* Then make a selection from the menu
*
+ * KNOWN BUGS:
+ *
+ * - pass_thru seems to always use buffering (even with ob_implicit_flush()),
+ * that make output slow when doxygen parses language files.
+ * - the menu doesnt work, got disabled at revision 13740. Need to code it.
+ *
+ *
+ * @file
* @todo document
- * @package MediaWiki
- * @subpackage Maintenance
+ * @ingroup Maintenance
*
* @author Ashar Voultoiz <thoane@altern.org>
* @version first release
#
if( php_sapi_name() != 'cli' ) {
- die( "Run me from the command line." );
+ echo 'Run me from the command line.';
+ die( -1 );
}
-/** Phpdoc script with full path */
-#$pdExec = '/usr/bin/phpdoc';
-$pdExec = 'phpdoc';
-
-/** Figure out the base directory. This is harder than it should be. */
-/** Since we're on the command line, don't trust the PWD! */
-$here = null;
-$self = $_SERVER['SCRIPT_FILENAME'];
-$sep = DIRECTORY_SEPARATOR;
-foreach( get_included_files() as $f ) {
- if( preg_match( "!^(.*)maintenance$sep$self\$!", $f, $matches ) ) {
- $here = $matches[1];
- }
-}
-if( is_null( $here ) ) {
- die( "Couldn't determine current directory.\n" );
-}
+/** Figure out the base directory for MediaWiki location */
+$mwPath = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR;
-/** where Phpdoc should output documentation */
-#$pdOutput = '/var/www/mwdoc/';
-$pdOutput = "{$here}{$sep}docs{$sep}html";
+/** Global variable: temporary directory */
+$tmpPath = '/tmp/';
+
+/** doxygen binary script */
+$doxygenBin = 'doxygen';
-/** Some more Phpdoc settings */
-$pdOthers = '';
-//$pdOthers = ' -dn \'MediaWiki\' ';
-$pdOthers .= ' --title \'MediaWiki generated documentation\' -o \'HTML:frames:DOM/earthli\' ';
+/** doxygen configuration template for mediawiki */
+$doxygenTemplate = $mwPath . 'maintenance/Doxyfile';
-/** MediaWiki location */
-#$mwPath = '/var/www/mediawiki/';
-$mwPath = "{$here}{$sep}";
+/** where Phpdoc should output documentation */
+#$doxyOutput = '/var/www/mwdoc/';
+$doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR ;
/** MediaWiki subpaths */
$mwPathI = $mwPath.'includes/';
+$mwPathL = $mwPath.'languages/';
$mwPathM = $mwPath.'maintenance/';
$mwPathS = $mwPath.'skins/';
-$mwBaseFiles = $mwPath.'*php ';
-
/** Variable to get user input */
$input = '';
+
/** shell command that will be run */
-$command = '';
+$command = $doxygenBin;
#
# Functions
return $resp;
}
+/**
+ * Generate a configuration file given user parameters and return the temporary filename.
+ * @param $doxygenTemplate String: full path for the template.
+ * @param $outputDirectory String: directory where the stuff will be output.
+ * @param $stripFromPath String: path that should be stripped out (usually mediawiki base path).
+ * @param $input String: Path to analyze.
+ */
+function generateConfigFile($doxygenTemplate, $outputDirectory, $stripFromPath, $input) {
+ global $tmpPath ;
+
+ $template = file_get_contents($doxygenTemplate);
+
+ // Replace template placeholders by correct values.
+ $tmpCfg = str_replace(
+ array(
+ '{{OUTPUT_DIRECTORY}}',
+ '{{STRIP_FROM_PATH}}',
+ '{{INPUT}}',
+ ),
+ array(
+ $outputDirectory,
+ $stripFromPath,
+ $input,
+ ),
+ $template
+ );
+ $tmpFileName = $tmpPath . 'mwdocgen'. rand() .'.tmp';
+ file_put_contents( $tmpFileName , $tmpCfg ) or die("Could not write doxygen configuration to file $tmpFileName\n");
+
+ return $tmpFileName;
+}
+
#
# Main !
#
-if( is_array( $argv ) && isset( $argv[1] ) && $argv[1] == '--all' ) {
- # Quick option
- $input = 0;
-} else {
- print <<<END
-Several documentation possibilities:
- 0 : whole documentation (1 + 2 + 3)
- 1 : only includes
- 2 : only maintenance
- 3 : only skins
- 4 : only a given file
-END;
+unset( $file );
+
+if( is_array( $argv ) && isset( $argv[1] ) ) {
+ switch( $argv[1] ) {
+ case '--all': $input = 0; break;
+ case '--includes': $input = 1; break;
+ case '--languages': $input = 2; break;
+ case '--maintenance': $input = 3; break;
+ case '--skins': $input = 4; break;
+ case '--file':
+ $input = 5;
+ if( isset( $argv[2] ) ) {
+ $file = $argv[2];
+ }
+ break;
+ }
+}
+if( $input === '' ) {
+?>Several documentation possibilities:
+ 0 : whole documentation (1 + 2 + 3 + 4)
+ 1 : only includes
+ 2 : only languages
+ 3 : only maintenance
+ 4 : only skins
+ 5 : only a given file<?php
while ( !is_numeric($input) )
{
$input = readaline( "\nEnter your choice [0]:" );
}
}
}
-
-$command = 'phpdoc ';
+/*
switch ($input) {
case 0:
- $command .= " -f $mwBaseFiles -d $mwPathI,$mwPathM,$mwPathS ";
+ $command .= " -f $mwBaseFiles -d $mwPathI,$mwPathL,$mwPathM,$mwPathS";
break;
case 1:
- $command .= "-d $mwPathI ";
+ $command .= "-d $mwPathI";
break;
case 2:
- $command .= "-d $mwPathM ";
+ $command .= "-d $mwPathL";
break;
case 3:
- $command .= "-d $mwPathS ";
+ $command .= "-d $mwPathM";
break;
case 4:
- $file = readaline("\Enter file name $mwPath");
+ $command .= "-d $mwPathS";
+ break;
+case 5:
+ if( !isset( $file ) ) {
+ $file = readaline("Enter file name $mwPath");
+ }
$command .= ' -f '.$mwPath.$file;
}
$command .= " -t $pdOutput ".$pdOthers;
-print <<<END
+*/
+
+// TODO : generate a list of paths ))
+$input = $mwPath;
+
+$generatedConf = generateConfigFile($doxygenTemplate, $doxyOutput, $mwPath, $input );
+$command = $doxygenBin . ' ' . $generatedConf ;
+
+?>
---------------------------------------------------
Launching the command:
-$command
+
+<?php echo $command ?>
+
---------------------------------------------------
-END;
+<?php
-passthru( $command);
+passthru($command);
-print <<<END
+?>
---------------------------------------------------
-Phpdoc execution finished.
+Doxygen execution finished.
Check above for possible errors.
-END;
+You might want to deleted the temporary file <?php echo $generatedConf; ?>
+<?php
# phpdoc -d ./mediawiki/includes/ ./mediawiki/maintenance/ -f ./mediawiki/*php -t ./mwdoc/ -dn 'MediaWiki' --title 'MediaWiki generated documentation' -o 'HTML:frames:DOM/earthli'
dépôts / lhc / web / wiklou.git / blobdiff