| Index: trunk/phase3/includes/CacheDependency.php |
| — | — | @@ -12,8 +12,8 @@ |
| 13 | 13 | |
| 14 | 14 | /** |
| 15 | 15 | * Create an instance. |
| 16 | | - * @param mixed $value The user-supplied value |
| 17 | | - * @param mixed $deps A dependency or dependency array. All dependencies |
| | 16 | + * @param $value Mixed: the user-supplied value |
| | 17 | + * @param $deps Mixed: a dependency or dependency array. All dependencies |
| 18 | 18 | * must be objects implementing CacheDependency. |
| 19 | 19 | */ |
| 20 | 20 | function __construct( $value = false, $deps = array() ) { |
| — | — | @@ -66,12 +66,12 @@ |
| 67 | 67 | * it will be generated with the callback function (if present), and the newly |
| 68 | 68 | * calculated value will be stored to the cache in a wrapper. |
| 69 | 69 | * |
| 70 | | - * @param object $cache A cache object such as $wgMemc |
| 71 | | - * @param string $key The cache key |
| 72 | | - * @param integer $expiry The expiry timestamp or interval in seconds |
| 73 | | - * @param mixed $callback The callback for generating the value, or false |
| 74 | | - * @param array $callbackParams The function parameters for the callback |
| 75 | | - * @param array $deps The dependencies to store on a cache miss. Note: these |
| | 70 | + * @param $cache Object: a cache object such as $wgMemc |
| | 71 | + * @param $key String: the cache key |
| | 72 | + * @param $expiry Integer: the expiry timestamp or interval in seconds |
| | 73 | + * @param $callback Mixed: the callback for generating the value, or false |
| | 74 | + * @param $callbackParams Array: the function parameters for the callback |
| | 75 | + * @param $deps Array: the dependencies to store on a cache miss. Note: these |
| 76 | 76 | * are not the dependencies used on a cache hit! Cache hits use the stored |
| 77 | 77 | * dependency array. |
| 78 | 78 | * |
| — | — | @@ -120,8 +120,8 @@ |
| 121 | 121 | /** |
| 122 | 122 | * Create a file dependency |
| 123 | 123 | * |
| 124 | | - * @param string $filename The name of the file, preferably fully qualified |
| 125 | | - * @param mixed $timestamp The unix last modified timestamp, or false if the |
| | 124 | + * @param $filename String: the name of the file, preferably fully qualified |
| | 125 | + * @param $timestamp Mixed: the unix last modified timestamp, or false if the |
| 126 | 126 | * file does not exist. If omitted, the timestamp will be loaded from |
| 127 | 127 | * the file. |
| 128 | 128 | * |
| — | — | @@ -185,7 +185,7 @@ |
| 186 | 186 | |
| 187 | 187 | /** |
| 188 | 188 | * Construct a title dependency |
| 189 | | - * @param Title $title |
| | 189 | + * @param $title Title |
| 190 | 190 | */ |
| 191 | 191 | function __construct( Title $title ) { |
| 192 | 192 | $this->titleObj = $title; |
| Index: trunk/phase3/includes/BacklinkCache.php |
| — | — | @@ -47,7 +47,9 @@ |
| 48 | 48 | |
| 49 | 49 | /** |
| 50 | 50 | * Get the backlinks for a given table. Cached in process memory only. |
| 51 | | - * @param string $table |
| | 51 | + * @param $table String |
| | 52 | + * @param $startId Integer or false |
| | 53 | + * @param $endId Integer or false |
| 52 | 54 | * @return TitleArray |
| 53 | 55 | */ |
| 54 | 56 | public function getLinks( $table, $startId = false, $endId = false ) { |
| — | — | @@ -169,9 +171,9 @@ |
| 170 | 172 | * Returns an array giving the start and end of each range. The first batch has |
| 171 | 173 | * a start of false, and the last batch has an end of false. |
| 172 | 174 | * |
| 173 | | - * @param string $table The links table name |
| 174 | | - * @param integer $batchSize |
| 175 | | - * @return array |
| | 175 | + * @param $table String: the links table name |
| | 176 | + * @param $batchSize Integer |
| | 177 | + * @return Array |
| 176 | 178 | */ |
| 177 | 179 | public function partition( $table, $batchSize ) { |
| 178 | 180 | // Try cache |
| Index: trunk/phase3/includes/ChangesList.php |
| — | — | @@ -29,7 +29,7 @@ |
| 30 | 30 | |
| 31 | 31 | /** |
| 32 | 32 | * Changeslist contructor |
| 33 | | - * @param Skin $skin |
| | 33 | + * @param $skin Skin |
| 34 | 34 | */ |
| 35 | 35 | public function __construct( $skin ) { |
| 36 | 36 | $this->skin = $skin; |
| — | — | @@ -56,7 +56,7 @@ |
| 57 | 57 | |
| 58 | 58 | /** |
| 59 | 59 | * Sets the list to use a <li class="watchlist-(namespace)-(page)"> tag |
| 60 | | - * @param bool $value |
| | 60 | + * @param $value Boolean |
| 61 | 61 | */ |
| 62 | 62 | public function setWatchlistDivs( $value = true ) { |
| 63 | 63 | $this->watchlist = $value; |
| — | — | @@ -78,12 +78,12 @@ |
| 79 | 79 | |
| 80 | 80 | /** |
| 81 | 81 | * Returns the appropriate flags for new page, minor change and patrolling |
| 82 | | - * @param bool $new |
| 83 | | - * @param bool $minor |
| 84 | | - * @param bool $patrolled |
| 85 | | - * @param string $nothing, string to use for empty space |
| 86 | | - * @param bool $bot |
| 87 | | - * @return string |
| | 82 | + * @param $new Boolean |
| | 83 | + * @param $minor Boolean |
| | 84 | + * @param $patrolled Boolean |
| | 85 | + * @param $nothing String to use for empty space |
| | 86 | + * @param $bot Boolean |
| | 87 | + * @return String |
| 88 | 88 | */ |
| 89 | 89 | protected function recentChangesFlags( $new, $minor, $patrolled, $nothing = ' ', $bot = false ) { |
| 90 | 90 | $f = $new ? self::flag( 'newpage' ) : $nothing; |
| — | — | @@ -99,8 +99,8 @@ |
| 100 | 100 | * unpatrolled edit. By default in English it will contain "N", "m", "b", |
| 101 | 101 | * "!" respectively, plus it will have an appropriate title and class. |
| 102 | 102 | * |
| 103 | | - * @param $key string 'newpage', 'unpatrolled', 'minor', or 'bot' |
| 104 | | - * @return string Raw HTML |
| | 103 | + * @param $key String: 'newpage', 'unpatrolled', 'minor', or 'bot' |
| | 104 | + * @return String: Raw HTML |
| 105 | 105 | */ |
| 106 | 106 | public static function flag( $key ) { |
| 107 | 107 | static $messages = null; |
| — | — | @@ -128,8 +128,8 @@ |
| 129 | 129 | * explaining what the flags mean. For instance, "N - new page". See |
| 130 | 130 | * also flag(). |
| 131 | 131 | * |
| 132 | | - * @param $key string 'newpage', 'unpatrolled', 'minor', or 'bot' |
| 133 | | - * @return string Raw HTML |
| | 132 | + * @param $key String: 'newpage', 'unpatrolled', 'minor', or 'bot' |
| | 133 | + * @return String: Raw HTML |
| 134 | 134 | */ |
| 135 | 135 | private static function flagLine( $key ) { |
| 136 | 136 | return wfMsgExt( "recentchanges-legend-$key", array( 'escapenoentities', |
| — | — | @@ -139,7 +139,7 @@ |
| 140 | 140 | /** |
| 141 | 141 | * A handy legend to tell users what the little "m", "b", and so on mean. |
| 142 | 142 | * |
| 143 | | - * @return string Raw HTML |
| | 143 | + * @return String: Raw HTML |
| 144 | 144 | */ |
| 145 | 145 | public static function flagLegend() { |
| 146 | 146 | global $wgGroupPermissions, $wgLang; |
| — | — | @@ -166,7 +166,7 @@ |
| 167 | 167 | |
| 168 | 168 | /** |
| 169 | 169 | * Returns text for the start of the tabular part of RC |
| 170 | | - * @return string |
| | 170 | + * @return String |
| 171 | 171 | */ |
| 172 | 172 | public function beginRecentChangesList() { |
| 173 | 173 | $this->rc_cache = array(); |
| — | — | @@ -179,9 +179,9 @@ |
| 180 | 180 | |
| 181 | 181 | /** |
| 182 | 182 | * Show formatted char difference |
| 183 | | - * @param int $old bytes |
| 184 | | - * @param int $new bytes |
| 185 | | - * @returns string |
| | 183 | + * @param $old Integer: bytes |
| | 184 | + * @param $new Integer: bytes |
| | 185 | + * @returns String |
| 186 | 186 | */ |
| 187 | 187 | public static function showCharacterDifference( $old, $new ) { |
| 188 | 188 | global $wgRCChangedSizeThreshold, $wgLang, $wgMiserMode; |
| — | — | @@ -215,7 +215,7 @@ |
| 216 | 216 | |
| 217 | 217 | /** |
| 218 | 218 | * Returns text for the end of RC |
| 219 | | - * @return string |
| | 219 | + * @return String |
| 220 | 220 | */ |
| 221 | 221 | public function endRecentChangesList() { |
| 222 | 222 | if( $this->rclistOpen ) { |
| — | — | @@ -404,7 +404,7 @@ |
| 405 | 405 | |
| 406 | 406 | /** |
| 407 | 407 | * Check whether to enable recent changes patrol features |
| 408 | | - * @return bool |
| | 408 | + * @return Boolean |
| 409 | 409 | */ |
| 410 | 410 | public static function usePatrol() { |
| 411 | 411 | global $wgUser; |
| — | — | @@ -430,9 +430,9 @@ |
| 431 | 431 | |
| 432 | 432 | /** |
| 433 | 433 | * Determine if said field of a revision is hidden |
| 434 | | - * @param RCCacheEntry $rc |
| 435 | | - * @param int $field one of DELETED_* bitfield constants |
| 436 | | - * @return bool |
| | 434 | + * @param $rc RCCacheEntry |
| | 435 | + * @param $field Integer: one of DELETED_* bitfield constants |
| | 436 | + * @return Boolean |
| 437 | 437 | */ |
| 438 | 438 | public static function isDeleted( $rc, $field ) { |
| 439 | 439 | return ( $rc->mAttribs['rc_deleted'] & $field ) == $field; |
| — | — | @@ -441,9 +441,9 @@ |
| 442 | 442 | /** |
| 443 | 443 | * Determine if the current user is allowed to view a particular |
| 444 | 444 | * field of this revision, if it's marked as deleted. |
| 445 | | - * @param RCCacheEntry $rc |
| 446 | | - * @param int $field |
| 447 | | - * @return bool |
| | 445 | + * @param $rc RCCacheEntry |
| | 446 | + * @param $field Integer |
| | 447 | + * @return Boolean |
| 448 | 448 | */ |
| 449 | 449 | public static function userCan( $rc, $field ) { |
| 450 | 450 | if( $rc->mAttribs['rc_type'] == RC_LOG ) { |
| — | — | @@ -591,9 +591,9 @@ |
| 592 | 592 | */ |
| 593 | 593 | class EnhancedChangesList extends ChangesList { |
| 594 | 594 | /** |
| 595 | | - * Add the JavaScript file for enhanced changeslist |
| 596 | | - * @ return string |
| 597 | | - */ |
| | 595 | + * Add the JavaScript file for enhanced changeslist |
| | 596 | + * @return String |
| | 597 | + */ |
| 598 | 598 | public function beginRecentChangesList() { |
| 599 | 599 | global $wgStylePath, $wgStyleVersion; |
| 600 | 600 | $this->rc_cache = array(); |
| — | — | @@ -1021,10 +1021,10 @@ |
| 1022 | 1022 | |
| 1023 | 1023 | /** |
| 1024 | 1024 | * Generate HTML for an arrow or placeholder graphic |
| 1025 | | - * @param string $dir one of '', 'd', 'l', 'r' |
| 1026 | | - * @param string $alt text |
| 1027 | | - * @param string $title text |
| 1028 | | - * @return string HTML <img> tag |
| | 1025 | + * @param $dir String: one of '', 'd', 'l', 'r' |
| | 1026 | + * @param $alt String: text |
| | 1027 | + * @param $title String: text |
| | 1028 | + * @return String: HTML <img> tag |
| 1029 | 1029 | */ |
| 1030 | 1030 | protected function arrow( $dir, $alt='', $title='' ) { |
| 1031 | 1031 | global $wgStylePath; |
| — | — | @@ -1037,7 +1037,7 @@ |
| 1038 | 1038 | /** |
| 1039 | 1039 | * Generate HTML for a right- or left-facing arrow, |
| 1040 | 1040 | * depending on language direction. |
| 1041 | | - * @return string HTML <img> tag |
| | 1041 | + * @return String: HTML <img> tag |
| 1042 | 1042 | */ |
| 1043 | 1043 | protected function sideArrow() { |
| 1044 | 1044 | global $wgContLang; |
| — | — | @@ -1048,7 +1048,7 @@ |
| 1049 | 1049 | /** |
| 1050 | 1050 | * Generate HTML for a down-facing arrow |
| 1051 | 1051 | * depending on language direction. |
| 1052 | | - * @return string HTML <img> tag |
| | 1052 | + * @return String: HTML <img> tag |
| 1053 | 1053 | */ |
| 1054 | 1054 | protected function downArrow() { |
| 1055 | 1055 | return $this->arrow( 'd', '-', wfMsg( 'rc-enhanced-hide' ) ); |
| — | — | @@ -1056,7 +1056,7 @@ |
| 1057 | 1057 | |
| 1058 | 1058 | /** |
| 1059 | 1059 | * Generate HTML for a spacer image |
| 1060 | | - * @return string HTML <img> tag |
| | 1060 | + * @return String: HTML <img> tag |
| 1061 | 1061 | */ |
| 1062 | 1062 | protected function spacerArrow() { |
| 1063 | 1063 | return $this->arrow( '', codepointToUtf8( 0xa0 ) ); // non-breaking space |
| — | — | @@ -1064,7 +1064,7 @@ |
| 1065 | 1065 | |
| 1066 | 1066 | /** |
| 1067 | 1067 | * Add a set of spaces |
| 1068 | | - * @return string HTML <td> tag |
| | 1068 | + * @return String: HTML <td> tag |
| 1069 | 1069 | */ |
| 1070 | 1070 | protected function spacerIndent() { |
| 1071 | 1071 | return ' '; |
| — | — | @@ -1072,7 +1072,7 @@ |
| 1073 | 1073 | |
| 1074 | 1074 | /** |
| 1075 | 1075 | * Enhanced RC ungrouped line. |
| 1076 | | - * @return string a HTML formated line (generated using $r) |
| | 1076 | + * @return String: a HTML formated line (generated using $r) |
| 1077 | 1077 | */ |
| 1078 | 1078 | protected function recentChangesBlockLine( $rcObj ) { |
| 1079 | 1079 | global $wgRCShowChangedSize; |
| Index: trunk/phase3/includes/AuthPlugin.php |
| — | — | @@ -98,7 +98,7 @@ |
| 99 | 99 | * The User object is passed by reference so it can be modified; don't |
| 100 | 100 | * forget the & on your function declaration. |
| 101 | 101 | * |
| 102 | | - * @param User $user |
| | 102 | + * @param $user User object |
| 103 | 103 | */ |
| 104 | 104 | public function updateUser( &$user ) { |
| 105 | 105 | # Override this and do something |
| — | — | @@ -117,7 +117,7 @@ |
| 118 | 118 | * |
| 119 | 119 | * This is just a question, and shouldn't perform any actions. |
| 120 | 120 | * |
| 121 | | - * @return bool |
| | 121 | + * @return Boolean |
| 122 | 122 | */ |
| 123 | 123 | public function autoCreate() { |
| 124 | 124 | return false; |
| — | — | @@ -128,7 +128,7 @@ |
| 129 | 129 | * and use the same keys. 'Realname' 'Emailaddress' and 'Nickname' |
| 130 | 130 | * all reference this. |
| 131 | 131 | * |
| 132 | | - * @return bool |
| | 132 | + * @return Boolean |
| 133 | 133 | */ |
| 134 | 134 | public function allowPropChange( $prop = '' ) { |
| 135 | 135 | if( $prop == 'realname' && is_callable( array( $this, 'allowRealNameChange' ) ) ) { |
| — | — | @@ -172,7 +172,7 @@ |
| 173 | 173 | * Return true if successful. |
| 174 | 174 | * |
| 175 | 175 | * @param $user User object. |
| 176 | | - * @return bool |
| | 176 | + * @return Boolean |
| 177 | 177 | */ |
| 178 | 178 | public function updateExternalDB( $user ) { |
| 179 | 179 | return true; |
| — | — | @@ -181,7 +181,7 @@ |
| 182 | 182 | /** |
| 183 | 183 | * Check to see if external accounts can be created. |
| 184 | 184 | * Return true if external accounts can be created. |
| 185 | | - * @return bool |
| | 185 | + * @return Boolean |
| 186 | 186 | */ |
| 187 | 187 | public function canCreateAccounts() { |
| 188 | 188 | return false; |
| — | — | @@ -191,11 +191,11 @@ |
| 192 | 192 | * Add a user to the external authentication database. |
| 193 | 193 | * Return true if successful. |
| 194 | 194 | * |
| 195 | | - * @param User $user - only the name should be assumed valid at this point |
| 196 | | - * @param string $password |
| 197 | | - * @param string $email |
| 198 | | - * @param string $realname |
| 199 | | - * @return bool |
| | 195 | + * @param $user User: only the name should be assumed valid at this point |
| | 196 | + * @param $password String |
| | 197 | + * @param $email String |
| | 198 | + * @param $realname String |
| | 199 | + * @return Boolean |
| 200 | 200 | */ |
| 201 | 201 | public function addUser( $user, $password, $email='', $realname='' ) { |
| 202 | 202 | return true; |
| — | — | @@ -208,7 +208,7 @@ |
| 209 | 209 | * |
| 210 | 210 | * This is just a question, and shouldn't perform any actions. |
| 211 | 211 | * |
| 212 | | - * @return bool |
| | 212 | + * @return Boolean |
| 213 | 213 | */ |
| 214 | 214 | public function strict() { |
| 215 | 215 | return false; |
| — | — | @@ -219,7 +219,7 @@ |
| 220 | 220 | * If either this or strict() returns true, local authentication is not used. |
| 221 | 221 | * |
| 222 | 222 | * @param $username String: username. |
| 223 | | - * @return bool |
| | 223 | + * @return Boolean |
| 224 | 224 | */ |
| 225 | 225 | public function strictUserAuth( $username ) { |
| 226 | 226 | return false; |
| — | — | @@ -234,7 +234,7 @@ |
| 235 | 235 | * forget the & on your function declaration. |
| 236 | 236 | * |
| 237 | 237 | * @param $user User object. |
| 238 | | - * @param $autocreate bool True if user is being autocreated on login |
| | 238 | + * @param $autocreate Boolean: True if user is being autocreated on login |
| 239 | 239 | */ |
| 240 | 240 | public function initUser( &$user, $autocreate=false ) { |
| 241 | 241 | # Override this to do something. |
| — | — | @@ -252,7 +252,6 @@ |
| 253 | 253 | * Get an instance of a User object |
| 254 | 254 | * |
| 255 | 255 | * @param $user User |
| 256 | | - * @public |
| 257 | 256 | */ |
| 258 | 257 | public function getUserInstance( User &$user ) { |
| 259 | 258 | return new AuthPluginUser( $user ); |