Remove some stray executable bits

[lhc/web/wiklou.git] / maintenance / mwdocgen.php

diff --git a/maintenance/mwdocgen.php b/maintenance/mwdocgen.php
old mode 100755 (executable)
new mode 100644 (file)
index 4edbeee..135f7ed
--- a/maintenance/mwdocgen.php
+++ b/maintenance/mwdocgen.php
@@ -22,20 +22,40 @@
 # Variables / Configuration
 #
 
+if( php_sapi_name() != 'cli' ) {
+       echo "Run me from the command line.";
+       die( -1 );
+}
+
 /** Phpdoc script with full path */
-$pdExec        = '/usr/bin/phpdoc';
+#$pdExec       = '/usr/bin/phpdoc';
+$pdExec = 'phpdoc';
+
+/** Figure out the base directory. */
+$here = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR;
+
 /** where Phpdoc should output documentation */
-$pdOutput = '/var/www/mwdoc/';
+#$pdOutput = '/var/www/mwdoc/';
+$pdOutput = "{$here}docs" . DIRECTORY_SEPARATOR . 'html';
 
 /** Some more Phpdoc settings */
-//$pdOthers = ' -dn \'MediaWiki\' ';
-$pdOthers .= ' --title \'MediaWiki generated documentation\' -o \'HTML:frames:DOM/earthli\' ';
+# This will be used as the default for all files that don't have a package,
+# it's useful to set it to something like 'untagged' to hunt down and fix files
+# that don't have a package name declared.
+$pdOthers = " -dn MediaWiki";
+$pdOthers .= ' --title "MediaWiki generated documentation"';
+$pdOthers .= ' --output "HTML:Smarty:HandS"'; #,HTML:Smarty:HandS"'; ###### HTML:frames:DOM/earthli
+$pdOthers .= ' --ignore AdminSettings.php,LocalSettings.php,tests/LocalTestSettings.php';
+$pdOthers .= ' --parseprivate on';
+$pdOthers .= ' --sourcecode on';
 
 /** MediaWiki location */
-$mwPath = '/var/www/mediawiki/';
+#$mwPath = '/var/www/mediawiki/';
+$mwPath = "{$here}";
 
 /** MediaWiki subpaths */
 $mwPathI = $mwPath.'includes/';
+$mwPathL = $mwPath.'languages/';
 $mwPathM = $mwPath.'maintenance/';
 $mwPathS = $mwPath.'skins/';
 $mwBaseFiles = $mwPath.'*php ';
@@ -62,60 +82,83 @@ function readaline( $prompt = '') {
 # Main !
 #
 
-print <<<END
-Several documentation possibilities:
+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)
  1 : only includes
- 2 : only maintenance
- 3 : only skins
- 4 : only a given file
-END;
-
-while ( !is_numeric($input) )
-{
-       $input = readaline( "\nEnter your choice [0]:" );
-       if($input == '') {
-               $input = 0;
+ 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]:" );
+               if($input == '') {
+                       $input = 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
+?>
 ---------------------------------------------------
 Launching the command:
-$command
+
+<?php echo $command ?>
+
 ---------------------------------------------------
-END;
+<?php
 
-passthru( $command);
+passthru($command);
 
-print <<<END
+?>
 ---------------------------------------------------
 Phpdoc execution finished.
 Check above for possible errors.
-
-END;
-
+<?php
 
 # phpdoc -d ./mediawiki/includes/ ./mediawiki/maintenance/ -f ./mediawiki/*php -t ./mwdoc/ -dn 'MediaWiki' --title 'MediaWiki generated documentation' -o 'HTML:frames:DOM/earthli'