http://www.mediawiki.org/wiki/Special:Code/MediaWiki/72100
Revision: 72100
Author: nikerabbit
Date: 2010-09-01 12:02:17 +0000 (Wed, 01 Sep 2010)
Log Message:
-----------
Docu updates
Modified Paths:
--------------
trunk/extensions/Translate/Doxyfile
trunk/extensions/Translate/SpecialFirstSteps.php
trunk/extensions/Translate/SpecialImportTranslations.php
trunk/extensions/Translate/SpecialLanguageStats.php
trunk/extensions/Translate/SpecialMagic.php
trunk/extensions/Translate/SpecialMyLanguage.php
trunk/extensions/Translate/SpecialSupportedLanguages.php
trunk/extensions/Translate/SpecialTranslationChanges.php
trunk/extensions/Translate/SpecialTranslationStats.php
trunk/extensions/Translate/SpecialTranslations.php
trunk/extensions/Translate/Translate.php
trunk/extensions/Translate/scripts/cli.inc
trunk/extensions/Translate/scripts/groupStatistics.php
trunk/extensions/Translate/scripts/languageeditstats.php
trunk/extensions/Translate/utils/Font.php
trunk/extensions/Translate/utils/MemoryCache.php
trunk/extensions/Translate/utils/TranslationStats.php
Modified: trunk/extensions/Translate/Doxyfile
===================================================================
--- trunk/extensions/Translate/Doxyfile 2010-09-01 11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/Doxyfile 2010-09-01 12:02:17 UTC (rev 72100)
@@ -57,7 +57,7 @@
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT =
-FILE_PATTERNS = *.php
+FILE_PATTERNS = *.php *.inc
RECURSIVE = YES
EXCLUDE = spyc
EXCLUDE_SYMLINKS = YES
@@ -170,7 +170,7 @@
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
-TAGFILES =
+TAGFILES =
../../docs/html/tagfile.xml=http://svn.wikimedia.org/doc
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
Modified: trunk/extensions/Translate/SpecialFirstSteps.php
===================================================================
--- trunk/extensions/Translate/SpecialFirstSteps.php 2010-09-01 11:27:58 UTC
(rev 72099)
+++ trunk/extensions/Translate/SpecialFirstSteps.php 2010-09-01 12:02:17 UTC
(rev 72100)
@@ -13,7 +13,7 @@
* Implements a special page which assists users to become translators.
* Currently it is tailored for the needs of translatewiki.net
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage
*/
class SpecialFirstSteps extends UnlistedSpecialPage {
protected $skin, $user, $out;
Modified: trunk/extensions/Translate/SpecialImportTranslations.php
===================================================================
--- trunk/extensions/Translate/SpecialImportTranslations.php 2010-09-01
11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/SpecialImportTranslations.php 2010-09-01
12:02:17 UTC (rev 72100)
@@ -12,7 +12,7 @@
* Special page to import Gettext (.po) files exported using Translate
extension.
* Does not support generic Gettext files.
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage
*/
class SpecialImportTranslations extends SpecialPage {
/**
Modified: trunk/extensions/Translate/SpecialLanguageStats.php
===================================================================
--- trunk/extensions/Translate/SpecialLanguageStats.php 2010-09-01 11:27:58 UTC
(rev 72099)
+++ trunk/extensions/Translate/SpecialLanguageStats.php 2010-09-01 12:02:17 UTC
(rev 72100)
@@ -18,7 +18,7 @@
* Use {{Special:LanguageStats/nl/1}} to show for 'nl' and suppres completely
* translated groups.
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage Stats
*/
class SpecialLanguageStats extends IncludableSpecialPage {
function __construct() {
Modified: trunk/extensions/Translate/SpecialMagic.php
===================================================================
--- trunk/extensions/Translate/SpecialMagic.php 2010-09-01 11:27:58 UTC (rev
72099)
+++ trunk/extensions/Translate/SpecialMagic.php 2010-09-01 12:02:17 UTC (rev
72100)
@@ -9,14 +9,15 @@
*/
/**
- * This special page helps with the translations of MediaWiki features that are
+ * This special page helps with the translations of %MediaWiki features that
are
* not in the main messages array (special page aliases, magic words,
namespace names).
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage
*/
class SpecialMagic extends SpecialPage {
/**
* Message prefix for translations
+ * @todo Remove.
*/
const MSG = 'translate-magic-';
Modified: trunk/extensions/Translate/SpecialMyLanguage.php
===================================================================
--- trunk/extensions/Translate/SpecialMyLanguage.php 2010-09-01 11:27:58 UTC
(rev 72099)
+++ trunk/extensions/Translate/SpecialMyLanguage.php 2010-09-01 12:02:17 UTC
(rev 72100)
@@ -14,7 +14,7 @@
*
* Usage: [[Special:MyLanguage/Page name|link text]]
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage
*/
class SpecialMyLanguage extends UnlistedSpecialPage {
/**
Modified: trunk/extensions/Translate/SpecialSupportedLanguages.php
===================================================================
--- trunk/extensions/Translate/SpecialSupportedLanguages.php 2010-09-01
11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/SpecialSupportedLanguages.php 2010-09-01
12:02:17 UTC (rev 72100)
@@ -17,7 +17,7 @@
* "translators". The subpage "translators" must contain the template
* [[:{{ns:template}}:User|User]], taking a user name as parameter.
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage
*/
class SpecialSupportedLanguages extends UnlistedSpecialPage {
public function __construct() {
Modified: trunk/extensions/Translate/SpecialTranslationChanges.php
===================================================================
--- trunk/extensions/Translate/SpecialTranslationChanges.php 2010-09-01
11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/SpecialTranslationChanges.php 2010-09-01
12:02:17 UTC (rev 72100)
@@ -13,7 +13,7 @@
* Implementation of Special:TranslationChanges special page. Gives an overview
* per message group of translations in a given number of hours.
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage
*/
class SpecialTranslationChanges extends SpecialPage {
const MSG = 'translationchanges-';
Modified: trunk/extensions/Translate/SpecialTranslationStats.php
===================================================================
--- trunk/extensions/Translate/SpecialTranslationStats.php 2010-09-01
11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/SpecialTranslationStats.php 2010-09-01
12:02:17 UTC (rev 72100)
@@ -1,6 +1,7 @@
<?php
/**
* Contains logic for special page Special:TranslationStats.
+ * @defgroup Stats Statistics
*
* @file
* @author Niklas Laxström
@@ -11,7 +12,7 @@
/**
* Includable special page for generating graphs on translations.
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage Stats
* @todo Needs documentation.
*/
class SpecialTranslationStats extends IncludableSpecialPage {
Modified: trunk/extensions/Translate/SpecialTranslations.php
===================================================================
--- trunk/extensions/Translate/SpecialTranslations.php 2010-09-01 11:27:58 UTC
(rev 72099)
+++ trunk/extensions/Translate/SpecialTranslations.php 2010-09-01 12:02:17 UTC
(rev 72100)
@@ -13,7 +13,7 @@
* Implements a special page which shows all translations for a message.
* Bits taken from SpecialPrefixindex.php and TranslateTasks.php
*
- * @ingroup SpecialPage
+ * @ingroup SpecialPage TranslateSpecialPage
*/
class SpecialTranslations extends SpecialAllpages {
function __construct() {
Modified: trunk/extensions/Translate/Translate.php
===================================================================
--- trunk/extensions/Translate/Translate.php 2010-09-01 11:27:58 UTC (rev
72099)
+++ trunk/extensions/Translate/Translate.php 2010-09-01 12:02:17 UTC (rev
72100)
@@ -644,4 +644,4 @@
$wgNamespacesToBeSearchedDefault[$id] = true;
}
-/** @defgroup SpecialPage Special pages */
+/** @defgroup TranslateSpecialPage Special pages of Translate extension */
Modified: trunk/extensions/Translate/scripts/cli.inc
===================================================================
--- trunk/extensions/Translate/scripts/cli.inc 2010-09-01 11:27:58 UTC (rev
72099)
+++ trunk/extensions/Translate/scripts/cli.inc 2010-09-01 12:02:17 UTC (rev
72100)
@@ -7,8 +7,11 @@
* @copyright Copyright © 2008-2010, Niklas Laxström
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
2.0 or later
* @file
+ * @defgroup Script Command line scripts
+ * @todo Migrate cli scripts to use the new Maintenance class.
*/
+///@{
// Standard boilerplate to define $IP
if ( getenv( 'MW_INSTALL_PATH' ) !== false ) {
$IP = getenv( 'MW_INSTALL_PATH' );
@@ -17,7 +20,16 @@
}
define( 'TRANSLATE_CLI', 1 );
require_once( "$IP/maintenance/commandLine.inc" );
+///@}
+/**
+ * Output a message to command line (if available).
+ * @param $str \string The message.
+ * @param $channel \mixed Channel identifier. Consecutive messages to
+ * the same channel do not get automatic newlines between then,
+ * @param $force \bool Do not suppress output even if script was run
+ * with --quiet
+ */
function STDOUT( $str, $channel = null, $force = false ) {
global $options;
@@ -54,16 +66,28 @@
$lastChannel = $channel;
}
+/**
+ * Output a warning message to command line (if available).
+ * @see STDOUT
+ */
function STDERR( $message, $channel = null ) {
STDOUT( $message, $channel, true );
}
+///@{
register_shutdown_function('STDOUT', false);
+///@}
/**
- * @todo Needs documentation.
+ * A general CLI utility class.
+ * @todo Move elsewhere?
*/
class Cli {
+ /**
+ * Parses list of language codes to an array.
+ * @param $codes \string Command line input.
+ * @return \list{String} Language codes.
+ */
public static function parseLanguageCodes( /* string */ $codes ) {
$langs = array_map( 'trim', explode( ',', $codes ) );
if ( $langs[0] === '*' ) {
Modified: trunk/extensions/Translate/scripts/groupStatistics.php
===================================================================
--- trunk/extensions/Translate/scripts/groupStatistics.php 2010-09-01
11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/scripts/groupStatistics.php 2010-09-01
12:02:17 UTC (rev 72100)
@@ -7,6 +7,7 @@
* @copyright Copyright © 2007-2010, Niklas Laxström, Siebrand Mazeland
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
2.0 or later
* @file
+ * @ingroup Script Stats
*/
/**
@@ -164,6 +165,7 @@
/**
* @todo Needs documentation.
+ * @ingroup Stats
*/
class TranslateStatsOutput extends wikiStatsOutput {
function heading() {
Modified: trunk/extensions/Translate/scripts/languageeditstats.php
===================================================================
--- trunk/extensions/Translate/scripts/languageeditstats.php 2010-09-01
11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/scripts/languageeditstats.php 2010-09-01
12:02:17 UTC (rev 72100)
@@ -4,9 +4,10 @@
*
* @author Niklas Laxström
* @author Siebrand Mazeland
- * @copyright Copyright © 2008 Niklas Laxström, Siebrand Mazeland
+ * @copyright Copyright © 2008-2010 Niklas Laxström, Siebrand Mazeland
* @license http://www.gnu.org/copyleft/gpl.html GNU General Public License
2.0 or later
* @file
+ * @ingroup Script Stats
*/
$optionsWithArgs = array( 'top', 'days', 'bots', 'ns' );
Modified: trunk/extensions/Translate/utils/Font.php
===================================================================
--- trunk/extensions/Translate/utils/Font.php 2010-09-01 11:27:58 UTC (rev
72099)
+++ trunk/extensions/Translate/utils/Font.php 2010-09-01 12:02:17 UTC (rev
72100)
@@ -2,18 +2,24 @@
/**
* Contains class with wrapper around font-config.
*
+ * @author Niklas Laxström
+ * @copyright Copyright © 2008-2010, Niklas Laxström
+ * @license Public Domain
* @file
- * @author Niklas Laxström, 2008
- * @license Public Domain
*/
/**
* Wrapper around font-config to get useful ttf font given a language code.
- * Uses wfShellExec, wfEscapeShellArg and wfDebugLog from MediaWiki.
+ * Uses wfShellExec, wfEscapeShellArg and wfDebugLog, wfGetCache and
+ * wfMemckey from %MediaWiki.
*
- * @todo Needs documentation.
+ * @ingroup Stats
*/
class FCFontFinder {
+ /**
+ * Searches for suitable font in the system.
+ * @param $code \string Language code.
+ */
public static function find( $code ) {
if ( ini_get( 'open_basedir' ) ) {
wfDebugLog( 'fcfont', 'Disabled because of open_basedir
is active' );
Modified: trunk/extensions/Translate/utils/MemoryCache.php
===================================================================
--- trunk/extensions/Translate/utils/MemoryCache.php 2010-09-01 11:27:58 UTC
(rev 72099)
+++ trunk/extensions/Translate/utils/MemoryCache.php 2010-09-01 12:02:17 UTC
(rev 72100)
@@ -12,6 +12,7 @@
* Class for caching translation completion percentages.
* @todo Figure out a better name.
* @todo Tries to be generic, but is not.
+ * @ingroup Stats
*/
class ArrayMemoryCache {
/// Key for the data stored
Modified: trunk/extensions/Translate/utils/TranslationStats.php
===================================================================
--- trunk/extensions/Translate/utils/TranslationStats.php 2010-09-01
11:27:58 UTC (rev 72099)
+++ trunk/extensions/Translate/utils/TranslationStats.php 2010-09-01
12:02:17 UTC (rev 72100)
@@ -11,6 +11,7 @@
/**
* Contains methods that provide statistics for message groups.
+ * @ingroup Stats
*/
class TranslationStats {
/**
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
