maintenance/mwdocgen.php File Reference

Script to easily generate the mediawiki documentation using doxygen. More...

Go to the source code of this file.

Functions

 readaline ($prompt= '')
 Read a line from the shell.
 getSvnRevision ($dir)
 Copied from SpecialVersion::getSvnRevision().
 generateConfigFile ($doxygenTemplate, $outputDirectory, $stripFromPath, $currentVersion, $svnstat, $input)
 Generate a configuration file given user parameters and return the temporary filename.

Variables

if(php_sapi_name()!= 'cli') $mwPath = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR
 Figure out the base directory for MediaWiki location.
 $tmpPath = '/tmp/'
 Global variable: temporary directory.
 $doxygenBin = 'doxygen'
 doxygen binary script
 $doxygenTemplate = $mwPath . 'maintenance/Doxyfile'
 doxygen configuration template for mediawiki
 $svnstat = $mwPath . 'bin/svnstat'
 svnstat command, used to get the version of each file
 $doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR
 where Phpdoc should output documentation
 $mwPathI = $mwPath.'includes/'
 MediaWiki subpaths.
 $mwPathL = $mwPath.'languages/'
 $mwPathM = $mwPath.'maintenance/'
 $mwPathS = $mwPath.'skins/'
 $input = ''
 Variable to get user input.
if(is_array($argv)&&isset($argv[1]))
if($input=== '') switch($input) 
$versionNumber = getSvnRevision( $input )
 $command = $doxygenBin . ' ' . $generatedConf


Detailed Description

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.

Usage: php mwdocgen.php

Then make a selection from the menu

KNOWN BUGS:

Todo:
document
Author:
Ashar Voultoiz <thoane@altern.org>
Version:
first release

Definition in file mwdocgen.php.


Function Documentation

generateConfigFile ( doxygenTemplate,
outputDirectory,
stripFromPath,
currentVersion,
svnstat,
input 
)

Generate a configuration file given user parameters and return the temporary filename.

Parameters:
$doxygenTemplate String: full path for the template.
$outputDirectory String: directory where the stuff will be output.
$stripFromPath String: path that should be stripped out (usually mediawiki base path).
$currentVersion String: Version number of the software
$svnstat String: path to the svnstat file
$input String: Path to analyze.

Definition at line 132 of file mwdocgen.php.

References $doxygenTemplate, $input, $svnstat, and $tmpPath.

getSvnRevision ( dir  ) 

Copied from SpecialVersion::getSvnRevision().

Parameters:
$dir String
Returns:
Mixed: string or false

Definition at line 86 of file mwdocgen.php.

Referenced by ApiQuerySiteinfo::appendGeneralInfo().

readaline ( prompt = ''  ) 

Read a line from the shell.

Parameters:
$prompt String

Definition at line 73 of file mwdocgen.php.

References print.


Variable Documentation

$command = $doxygenBin . ' ' . $generatedConf

$doxygenBin = 'doxygen'

doxygen binary script

Definition at line 44 of file mwdocgen.php.

$doxygenTemplate = $mwPath . 'maintenance/Doxyfile'

doxygen configuration template for mediawiki

Definition at line 47 of file mwdocgen.php.

Referenced by generateConfigFile().

$doxyOutput = $mwPath . 'docs' . DIRECTORY_SEPARATOR

where Phpdoc should output documentation

Definition at line 54 of file mwdocgen.php.

$input = ''

if (php_sapi_name()!= 'cli') $mwPath = dirname( dirname( __FILE__ ) ) . DIRECTORY_SEPARATOR

Figure out the base directory for MediaWiki location.

Definition at line 38 of file mwdocgen.php.

$mwPathI = $mwPath.'includes/'

MediaWiki subpaths.

Definition at line 57 of file mwdocgen.php.

$mwPathL = $mwPath.'languages/'

Definition at line 58 of file mwdocgen.php.

$mwPathM = $mwPath.'maintenance/'

Definition at line 59 of file mwdocgen.php.

$mwPathS = $mwPath.'skins/'

Definition at line 60 of file mwdocgen.php.

$svnstat = $mwPath . 'bin/svnstat'

svnstat command, used to get the version of each file

Definition at line 50 of file mwdocgen.php.

Referenced by generateConfigFile().

$tmpPath = '/tmp/'

Global variable: temporary directory.

Definition at line 41 of file mwdocgen.php.

Referenced by generateConfigFile().

if (is_array($argv)&&isset($argv[1])) if ($input=== '') switch ($input) $versionNumber = getSvnRevision( $input )

Definition at line 208 of file mwdocgen.php.


Generated on Sat Sep 5 02:08:27 2009 for MediaWiki by  doxygen 1.5.9