From ba2afcd9fa9b1f3f6a865da054068466164fd2fa Mon Sep 17 00:00:00 2001 From: Antoine Musso Date: Fri, 3 Sep 2004 23:00:01 +0000 Subject: [PATCH] Split files and classes in different packages for phpdocumentor. I probably changed some double quotes to single and used function foo () { shema --- includes/Block.php | 3 +++ includes/BlockCache.php | 2 ++ includes/CacheManager.php | 2 ++ includes/CategoryPage.php | 11 +++------ includes/Credits.php | 2 +- includes/Database.php | 9 ++++--- includes/DatabaseFunctions.php | 5 ++-- includes/DatabasePostgreSQL.php | 3 +++ includes/DateFormatter.php | 2 ++ includes/DefaultSettings.php | 9 +++---- includes/DifferenceEngine.php | 14 +++++++++++ includes/EditPage.php | 3 +++ includes/Feed.php | 13 ++++++---- includes/FulltextStoplist.php | 2 ++ includes/GlobalFunctions.php | 1 + includes/HistoryBlob.php | 3 +++ includes/Image.php | 3 ++- includes/ImagePage.php | 3 ++- includes/Interwiki.php | 1 + includes/LinkCache.php | 2 ++ includes/LinksUpdate.php | 2 ++ includes/LoadBalancer.php | 3 +++ includes/LogPage.php | 4 ++++ includes/MagicWord.php | 13 +++++++--- includes/Math.php | 3 +++ includes/MemcachedSessions.php | 2 ++ includes/MessageCache.php | 3 +++ includes/Metadata.php | 1 + includes/Namespace.php | 5 +++- includes/ObjectCache.php | 6 +++++ includes/OutputPage.php | 2 ++ includes/PageHistory.php | 2 ++ includes/Parser.php | 4 ++++ includes/ParserCache.php | 2 ++ includes/ParserXML.php | 3 +++ includes/Profiling.php | 2 ++ includes/QueryPage.php | 4 ++++ includes/RawPage.php | 2 ++ includes/RecentChange.php | 2 ++ includes/SearchEngine.php | 2 ++ includes/SearchUpdate.php | 2 ++ includes/Setup.php | 3 +++ includes/SiteConfiguration.php | 3 +++ includes/SiteStatsUpdate.php | 3 +++ includes/Skin.php | 3 +++ includes/SkinPHPTal.php | 3 +++ includes/SpecialAllmessages.php | 2 ++ includes/SpecialAllpages.php | 2 ++ includes/SpecialAncientpages.php | 4 ++++ includes/SpecialAsksql.php | 4 ++++ includes/SpecialBlockip.php | 4 ++++ includes/SpecialBlockme.php | 2 ++ includes/SpecialBooksources.php | 5 +++- includes/SpecialBrokenRedirects.php | 4 ++++ includes/SpecialCategories.php | 4 ++++ includes/SpecialContributions.php | 2 ++ includes/SpecialDeadendpages.php | 4 ++++ includes/SpecialDebug.php | 2 ++ includes/SpecialDisambiguations.php | 4 ++++ includes/SpecialDoubleRedirects.php | 4 ++++ includes/SpecialEmailuser.php | 4 ++++ includes/SpecialExport.php | 4 +++- includes/SpecialGeo.php | 2 ++ includes/SpecialImagelist.php | 2 ++ includes/SpecialImport.php | 6 +++++ includes/SpecialIpblocklist.php | 4 ++++ includes/SpecialListadmins.php | 4 ++++ includes/SpecialListusers.php | 4 ++++ includes/SpecialLockdb.php | 4 ++++ includes/SpecialLog.php | 6 +++++ includes/SpecialLonelypages.php | 4 ++++ includes/SpecialLongpages.php | 4 ++++ includes/SpecialMaintenance.php | 2 ++ includes/SpecialMakesysop.php | 4 ++++ includes/SpecialMovepage.php | 4 ++++ includes/SpecialNeglectedpages.php | 2 ++ includes/SpecialNewpages.php | 4 ++++ includes/SpecialPage.php | 4 ++++ includes/SpecialPopularpages.php | 4 ++++ includes/SpecialPreferences.php | 4 ++++ includes/SpecialRandompage.php | 6 ++--- includes/SpecialRecentchanges.php | 2 ++ includes/SpecialRecentchangeslinked.php | 2 ++ includes/SpecialSearch.php | 2 ++ includes/SpecialShortpages.php | 4 ++++ includes/SpecialSpecialpages.php | 2 ++ includes/SpecialStatistics.php | 2 ++ includes/SpecialUncategorizedpages.php | 4 ++++ includes/SpecialUndelete.php | 6 +++++ includes/SpecialUnlockdb.php | 4 ++++ includes/SpecialUnusedimages.php | 2 ++ includes/SpecialUpload.php | 4 ++++ includes/SpecialUserlogin.php | 4 ++++ includes/SpecialUserlogout.php | 2 ++ includes/SpecialValidate.php | 4 ++++ includes/SpecialVersion.php | 2 ++ includes/SpecialVote.php | 2 ++ includes/SpecialWantedpages.php | 4 ++++ includes/SpecialWatchlist.php | 2 ++ includes/SpecialWhatlinkshere.php | 2 ++ includes/SquidUpdate.php | 2 ++ includes/Title.php | 5 +++- includes/Tokenizer.php | 2 ++ includes/UpdateClasses.php | 1 + includes/User.php | 2 ++ includes/UserMailer.php | 1 + includes/UserTalkUpdate.php | 2 ++ includes/UserUpdate.php | 2 ++ includes/Utf8Case.php | 1 + includes/ViewCountUpdate.php | 5 +++- includes/WatchedItem.php | 2 ++ includes/WebRequest.php | 3 +++ includes/killthread.php | 1 + includes/normal/Utf8Test.php | 13 ++++++---- includes/normal/UtfNormal.php | 32 +++++++++++++++---------- includes/normal/UtfNormalBench.php | 8 ++++++- includes/normal/UtfNormalTest.php | 13 +++++++--- includes/normal/UtfNormalUtil.php | 11 ++++++--- includes/proxy_check.php | 1 + skins/WikimediaWiki.php | 5 ++++ 120 files changed, 416 insertions(+), 58 deletions(-) diff --git a/includes/Block.php b/includes/Block.php index 5cb81c4f2e..781dd9dc2a 100644 --- a/includes/Block.php +++ b/includes/Block.php @@ -1,6 +1,7 @@ '; } - - return $r ; } - - } - - ?> diff --git a/includes/Credits.php b/includes/Credits.php index a92c9f9289..1a9462a26f 100644 --- a/includes/Credits.php +++ b/includes/Credits.php @@ -1,5 +1,4 @@ . @@ -19,6 +18,7 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * * @author + * @package MediaWiki */ /** diff --git a/includes/Database.php b/includes/Database.php index 7a6cd9b5a2..829bb56a98 100644 --- a/includes/Database.php +++ b/includes/Database.php @@ -3,6 +3,7 @@ * This file deals with MySQL interface functions * and query specifics/optimisations * @version # $Id$ + * @package MediaWiki */ /** @@ -26,7 +27,7 @@ define( 'DEADLOCK_DELAY_MAX', 1500000 ); /** * Database abstraction object - * @category database + * @package MediaWiki * @version # $Id$ */ class Database { @@ -1197,7 +1198,8 @@ class Database { /** * Database abstraction object for mySQL * Inherit all methods and properties of Database::Database() - * @category database + * + * @package MediaWiki * @see Database * @version # $Id$ */ @@ -1208,7 +1210,8 @@ class DatabaseMysql extends Database { /** * Result wrapper for grabbing data queried by someone else - * @category database + * + * @package MediaWiki * @version # $Id$ */ class ResultWrapper { diff --git a/includes/DatabaseFunctions.php b/includes/DatabaseFunctions.php index 9cc61d16cb..dadc751460 100644 --- a/includes/DatabaseFunctions.php +++ b/includes/DatabaseFunctions.php @@ -5,6 +5,7 @@ * Note: $wgDatabase has ceased to exist. Destroy all references. * * @version # $Id$ + * @package MediaWiki */ /** @@ -90,7 +91,7 @@ function wfIgnoreSQLErrors( $newstate, $dbi = DB_LAST ) { } } -/**@#+ +/**#@+ * @param $res database result handler * @param $dbi */ @@ -176,7 +177,7 @@ function wfFieldName( $res, $n, $dbi = DB_LAST ) return false; } } -/**@#-*/ +/**#@-*/ /** * @todo document function diff --git a/includes/DatabasePostgreSQL.php b/includes/DatabasePostgreSQL.php index 21420a3650..20b2617222 100644 --- a/includes/DatabasePostgreSQL.php +++ b/includes/DatabasePostgreSQL.php @@ -15,6 +15,7 @@ * * Hashar * + * @package MediaWiki */ /** @@ -24,6 +25,7 @@ require_once( 'Database.php' ); /** * + * @package MediaWiki */ class DatabasePgsql extends Database { var $mInsertId = NULL; @@ -363,6 +365,7 @@ class DatabasePgsql extends Database { /** * Just an alias. + * @package MediaWiki */ class DatabasePostgreSQL extends DatabasePgsql { } diff --git a/includes/DateFormatter.php b/includes/DateFormatter.php index bf38aa7d56..e2d4c124dd 100755 --- a/includes/DateFormatter.php +++ b/includes/DateFormatter.php @@ -2,6 +2,7 @@ /** * Contain things * @todo document + * @package MediaWiki */ /** */ @@ -32,6 +33,7 @@ define('DF_LAST', 8); /** * @todo preferences, OutputPage + * @package MediaWiki */ class DateFormatter { diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php index 1a13e82444..71b2a54a49 100644 --- a/includes/DefaultSettings.php +++ b/includes/DefaultSettings.php @@ -1,7 +1,7 @@ \n"; } - /**@#-*/ + /**#@-*/ } /** * Generate a RSS feed * @todo document + * @package MediaWiki */ class RSSFeed extends ChannelFeed { @@ -211,6 +215,7 @@ class RSSFeed extends ChannelFeed { /** * Generate an Atom feed * @todo document + * @package MediaWiki */ class AtomFeed extends ChannelFeed { /** diff --git a/includes/FulltextStoplist.php b/includes/FulltextStoplist.php index 81feb36c78..c567641321 100644 --- a/includes/FulltextStoplist.php +++ b/includes/FulltextStoplist.php @@ -6,6 +6,7 @@ * * The list is used to strip out stopwords from search queries to avoid * nulling out the combined search results when using MySQL 3.x. + * @package MediaWiki */ /** @@ -18,6 +19,7 @@ global $wgFulltextStoplist; $wgFulltextStoplist = " a a's able about above according accordingly across actually after afterwards again against ain't all allow allows almost alone along already also although always am among amongst an and another any anybody anyhow anyone anything anyway anyways anywhere apart appear appreciate appropriate are aren't around as aside ask asking associated at available away awfully b be became because become becomes becoming been before beforehand behind being believe below beside besides best better between beyond both brief but by c c'mon c's came can can't cannot cant cause causes certain certainly changes clearly co com come comes concerning consequently consider considering contain containing contains corresponding could couldn't course currently d definitely described despite did didn't different do does doesn't doing don't done down downwards during e each edu eg eight either else elsewhere enough entirely especially et etc even ever every everybody everyone everything everywhere ex exactly example except f far few fifth first five followed following follows for former formerly forth four from further furthermore g get gets getting given gives go goes going gone got gotten greetings h had hadn't happens hardly has hasn't have haven't having he he's hello help hence her here here's hereafter hereby herein hereupon hers herself hi him himself his hither hopefully how howbeit however i i'd i'll i'm i've ie if ignored immediate in inasmuch inc indeed indicate indicated indicates inner insofar instead into inward is isn't it it'd it'll it's its itself j just k keep keeps kept know knows known l last lately later latter latterly least less lest let let's like liked likely little look looking looks ltd m mainly many may maybe me mean meanwhile merely might more moreover most mostly much must my myself n name namely nd near nearly necessary need needs neither never nevertheless new next nine no nobody non none noone nor normally not nothing novel now nowhere o obviously of off often oh ok okay old on once one ones only onto or other others otherwise ought our ours ourselves out outside over overall own p particular particularly per perhaps placed please plus possible presumably probably provides q que quite qv r rather rd re really reasonably regarding regardless regards relatively respectively right s said same saw say saying says second secondly see seeing seem seemed seeming seems seen self selves sensible sent serious seriously seven several shall she should shouldn't since six so some somebody somehow someone something sometime sometimes somewhat somewhere soon sorry specified specify specifying still sub such sup sure t t's take taken tell tends th than thank thanks thanx that that's thats the their theirs them themselves then thence there there's thereafter thereby therefore therein theres thereupon these they they'd they'll they're they've think third this thorough thoroughly those though three through throughout thru thus to together too took toward towards tried tries truly try trying twice two u un under unfortunately unless unlikely until unto up upon us use used useful uses using usually v value various very via viz vs w want wants was wasn't way we we'd we'll we're we've welcome well went were weren't what what's whatever when whence whenever where where's whereafter whereas whereby wherein whereupon wherever whether which while whither who who's whoever whole whom whose why will willing wish with within without won't wonder would would wouldn't x y yes yet you you'd you'll you're you've your yours yourself yourselves z zero "; /** + * @package MediaWiki */ class FulltextStoplist { diff --git a/includes/GlobalFunctions.php b/includes/GlobalFunctions.php index 45a71d0e59..496885cc90 100644 --- a/includes/GlobalFunctions.php +++ b/includes/GlobalFunctions.php @@ -3,6 +3,7 @@ /** * Global functions used everywhere + * @package MediaWiki */ /** diff --git a/includes/HistoryBlob.php b/includes/HistoryBlob.php index 10251fb2c3..0c44b34415 100644 --- a/includes/HistoryBlob.php +++ b/includes/HistoryBlob.php @@ -1,10 +1,12 @@ diff --git a/includes/LinkCache.php b/includes/LinkCache.php index ce4594b6b6..9da6807671 100644 --- a/includes/LinkCache.php +++ b/includes/LinkCache.php @@ -1,6 +1,7 @@ mId = $id; diff --git a/includes/Math.php b/includes/Math.php index 9b7a996f6d..1f1ff1c2cf 100644 --- a/includes/Math.php +++ b/includes/Math.php @@ -1,6 +1,7 @@ parsing + * @package MediaWiki */ /** @@ -9,6 +10,8 @@ * rendering form is picked and returned. * * by Tomasz Wegrzanowski, with additions by Brion Vibber (2003, 2004) + * + * @package MediaWiki */ class MathRenderer { var $mode = MW_MATH_MODERN; diff --git a/includes/MemcachedSessions.php b/includes/MemcachedSessions.php index 289ea36961..af49109ce9 100644 --- a/includes/MemcachedSessions.php +++ b/includes/MemcachedSessions.php @@ -5,6 +5,8 @@ * instead of the local filesystem. Depending on circumstances, it may also * be necessary to change the cookie settings to work across hostnames. * See: http://www.php.net/manual/en/function.session-set-save-handler.php + * + * @package MediaWiki */ /** diff --git a/includes/MessageCache.php b/includes/MessageCache.php index 8f480e666a..247b700d8f 100755 --- a/includes/MessageCache.php +++ b/includes/MessageCache.php @@ -1,6 +1,7 @@ + * @package MediaWiki */ /** diff --git a/includes/Namespace.php b/includes/Namespace.php index 81c4a491c1..43f0d78a3a 100644 --- a/includes/Namespace.php +++ b/includes/Namespace.php @@ -1,6 +1,7 @@ (X)HTML parser * Based on work by Jan Hidders and Magnus Manske + * @package MediaWiki */ /** * the base class for an element + * @package MediaWiki */ class element { var $name = ''; @@ -75,6 +77,7 @@ function wgXMLcharacterData($parser, $data) { /** * Here's the class that generates a nice tree * package parserxml + * @package MediaWiki */ class xml2php { diff --git a/includes/Profiling.php b/includes/Profiling.php index 163c4bc3ec..48129ec038 100755 --- a/includes/Profiling.php +++ b/includes/Profiling.php @@ -1,6 +1,7 @@ + * @package MediaWiki */ /** * @todo document + * @package MediaWiki */ class RawPage { diff --git a/includes/RecentChange.php b/includes/RecentChange.php index e7d16257a0..e35775be88 100644 --- a/includes/RecentChange.php +++ b/includes/RecentChange.php @@ -1,6 +1,7 @@ \ No newline at end of file +?> diff --git a/includes/SpecialGeo.php b/includes/SpecialGeo.php index 73c8f7aa4a..04e6c2b66f 100644 --- a/includes/SpecialGeo.php +++ b/includes/SpecialGeo.php @@ -19,6 +19,8 @@ /** * + * @package MediaWiki + * @subpackage SpecialPage */ /** diff --git a/includes/SpecialImagelist.php b/includes/SpecialImagelist.php index 7b762d0e7f..b50022495c 100644 --- a/includes/SpecialImagelist.php +++ b/includes/SpecialImagelist.php @@ -1,6 +1,8 @@ @@ -24,6 +25,7 @@ /** * Hypothetically, we could use a WebRequest object to fake a * self-contained request (FauxRequest). + * @package MediaWiki */ class WebRequest { function WebRequest() { @@ -228,6 +230,7 @@ class WebRequest { /** * + * @package MediaWiki */ class FauxRequest extends WebRequest { var $data = null; diff --git a/includes/killthread.php b/includes/killthread.php index 66d4fdaa96..819c91fb57 100644 --- a/includes/killthread.php +++ b/includes/killthread.php @@ -1,6 +1,7 @@ \ No newline at end of file +?> diff --git a/includes/normal/UtfNormal.php b/includes/normal/UtfNormal.php index 5ccdf0cde7..9dfc0a71bb 100644 --- a/includes/normal/UtfNormal.php +++ b/includes/normal/UtfNormal.php @@ -17,17 +17,22 @@ # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # http://www.gnu.org/copyleft/gpl.html -# Unicode normalization routines for working with UTF-8 strings. -# Currently assumes that input strings are valid UTF-8! -# -# Not as fast as I'd like, but should be usable for most purposes. -# UtfNormal::toNFC() will bail early if given ASCII text or text -# it can quickly deterimine is already normalized. -# -# All functions can be called static. -# -# See description of forms at http://www.unicode.org/reports/tr15/ +/** + * Unicode normalization routines for working with UTF-8 strings. + * Currently assumes that input strings are valid UTF-8! + * + * Not as fast as I'd like, but should be usable for most purposes. + * UtfNormal::toNFC() will bail early if given ASCII text or text + * it can quickly deterimine is already normalized. + * + * All functions can be called static. + * + * See description of forms at http://www.unicode.org/reports/tr15/ + * + * @package MediaWiki + */ +/** */ require_once 'UtfNormalUtil.php'; require_once 'UtfNormalData.inc'; @@ -87,7 +92,10 @@ define( 'UTF8_FFFF', codepointToUtf8( 0xffff ) ); define( 'UTF8_HEAD', false ); define( 'UTF8_TAIL', true ); - +/** + * + * @package MediaWiki + */ class UtfNormal { # The ultimate convenience function! Clean up invalid UTF-8 sequences, # and convert to normal form C. Faster on pure ASCII strings, or @@ -471,4 +479,4 @@ class UtfNormal { } } -?> \ No newline at end of file +?> diff --git a/includes/normal/UtfNormalBench.php b/includes/normal/UtfNormalBench.php index dcb83cf503..c37fb46928 100644 --- a/includes/normal/UtfNormalBench.php +++ b/includes/normal/UtfNormalBench.php @@ -17,6 +17,12 @@ # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # http://www.gnu.org/copyleft/gpl.html +/** + * + * @package MediaWiki + */ + +/** */ require_once 'UtfNormalUtil.php'; require_once 'UtfNormal.php'; @@ -76,4 +82,4 @@ function benchmarkForm( &$u, &$data, $form ) { printf( " %20s %1.4fs %8d bytes/s (%s)\n", $form, $delta, $rate, ($same ? 'no change' : 'changed' ) ); } -?> \ No newline at end of file +?> diff --git a/includes/normal/UtfNormalTest.php b/includes/normal/UtfNormalTest.php index 5a37edfd33..6360a7ca44 100644 --- a/includes/normal/UtfNormalTest.php +++ b/includes/normal/UtfNormalTest.php @@ -17,9 +17,13 @@ # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # http://www.gnu.org/copyleft/gpl.html -# Implements the conformance test at: -# http://www.unicode.org/Public/UNIDATA/NormalizationTest.txt +/** + * Implements the conformance test at: + * http://www.unicode.org/Public/UNIDATA/NormalizationTest.txt + * @package MediaWiki + */ +/** */ $verbose = true; #define( 'PRETTY_UTF8', true ); @@ -30,6 +34,9 @@ if( defined( 'PRETTY_UTF8' ) ) { $string ); } } else { + /** + * @ignore + */ function pretty( $string ) { return trim( preg_replace( '/(.)/use', 'sprintf("%04X ", utf8ToCodepoint("$1"))', @@ -216,4 +223,4 @@ function testInvariant( &$u, $char, $desc, $reportFailure = false ) { return $result; } -?> \ No newline at end of file +?> diff --git a/includes/normal/UtfNormalUtil.php b/includes/normal/UtfNormalUtil.php index da8823fa5d..039ac3c090 100644 --- a/includes/normal/UtfNormalUtil.php +++ b/includes/normal/UtfNormalUtil.php @@ -17,9 +17,14 @@ # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. # http://www.gnu.org/copyleft/gpl.html -# Some of these functions are adapted from places in MediaWiki. -# Should probably merge them for consistency. +/** + * Some of these functions are adapted from places in MediaWiki. + * Should probably merge them for consistency. + * + * @package MediaWiki + */ +/** */ function codepointToUtf8( $codepoint ) { if($codepoint < 0x80) return chr($codepoint); if($codepoint < 0x800) return chr($codepoint >> 6 & 0x3f | 0xc0) . @@ -86,4 +91,4 @@ function escapeSingleString( $string ) { )); } -?> \ No newline at end of file +?> diff --git a/includes/proxy_check.php b/includes/proxy_check.php index 0b33e1253d..b017f3211c 100644 --- a/includes/proxy_check.php +++ b/includes/proxy_check.php @@ -1,6 +1,7 @@