| Index: trunk/phase3/includes/Interwiki.php |
| — | — | @@ -26,9 +26,9 @@ |
| 27 | 27 | |
| 28 | 28 | /** |
| 29 | 29 | * Check whether an interwiki prefix exists |
| 30 | | - * |
| 31 | | - * @return bool Whether it exists |
| 32 | | - * @param $prefix string Interwiki prefix to use |
| | 30 | + * |
| | 31 | + * @param $prefix String: interwiki prefix to use |
| | 32 | + * @return Boolean: whether it exists |
| 33 | 33 | */ |
| 34 | 34 | static public function isValidInterwiki( $prefix ) { |
| 35 | 35 | $result = self::fetch( $prefix ); |
| — | — | @@ -37,9 +37,9 @@ |
| 38 | 38 | |
| 39 | 39 | /** |
| 40 | 40 | * Fetch an Interwiki object |
| 41 | | - * |
| | 41 | + * |
| | 42 | + * @param $prefix String: interwiki prefix to use |
| 42 | 43 | * @return Interwiki Object, or null if not valid |
| 43 | | - * @param $prefix string Interwiki prefix to use |
| 44 | 44 | */ |
| 45 | 45 | static public function fetch( $prefix ) { |
| 46 | 46 | global $wgContLang; |
| — | — | @@ -72,8 +72,8 @@ |
| 73 | 73 | * |
| 74 | 74 | * @note More logic is explained in DefaultSettings. |
| 75 | 75 | * |
| 76 | | - * @param $prefix \type{\string} Interwiki prefix |
| 77 | | - * @return \type{\Interwiki} An interwiki object |
| | 76 | + * @param $prefix String: interwiki prefix |
| | 77 | + * @return Interwiki object |
| 78 | 78 | */ |
| 79 | 79 | protected static function getInterwikiCached( $prefix ) { |
| 80 | 80 | $value = self::getInterwikiCacheEntry( $prefix ); |
| — | — | @@ -95,8 +95,8 @@ |
| 96 | 96 | * |
| 97 | 97 | * @note More logic is explained in DefaultSettings. |
| 98 | 98 | * |
| 99 | | - * @param $prefix \type{\string} Database key |
| 100 | | - * @return \type{\string) The entry |
| | 99 | + * @param $prefix String: database key |
| | 100 | + * @return String: the entry |
| 101 | 101 | */ |
| 102 | 102 | protected static function getInterwikiCacheEntry( $prefix ) { |
| 103 | 103 | global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite; |
| — | — | @@ -133,8 +133,7 @@ |
| 134 | 134 | * Load the interwiki, trying first memcached then the DB |
| 135 | 135 | * |
| 136 | 136 | * @param $prefix The interwiki prefix |
| 137 | | - * @return bool The prefix is valid |
| 138 | | - * @static |
| | 137 | + * @return Boolean: the prefix is valid |
| 139 | 138 | */ |
| 140 | 139 | protected static function load( $prefix ) { |
| 141 | 140 | global $wgMemc, $wgInterwikiExpiry; |
| — | — | @@ -165,9 +164,8 @@ |
| 166 | 165 | /** |
| 167 | 166 | * Fill in member variables from an array (e.g. memcached result, Database::fetchRow, etc) |
| 168 | 167 | * |
| 169 | | - * @return bool Whether everything was there |
| 170 | | - * @param $res ResultWrapper Row from the interwiki table |
| 171 | | - * @static |
| | 168 | + * @param $mc Associative array: row from the interwiki table |
| | 169 | + * @return Boolean: whether everything was there |
| 172 | 170 | */ |
| 173 | 171 | protected static function loadFromArray( $mc ) { |
| 174 | 172 | if( isset( $mc['iw_url'] ) && isset( $mc['iw_local'] ) && isset( $mc['iw_trans'] ) ) { |
| — | — | @@ -183,8 +181,8 @@ |
| 184 | 182 | /** |
| 185 | 183 | * Get the URL for a particular title (or with $1 if no title given) |
| 186 | 184 | * |
| 187 | | - * @param $title string What text to put for the article name |
| 188 | | - * @return string The URL |
| | 185 | + * @param $title String: what text to put for the article name |
| | 186 | + * @return String: the URL |
| 189 | 187 | */ |
| 190 | 188 | public function getURL( $title = null ) { |
| 191 | 189 | $url = $this->mURL; |
| — | — | @@ -197,7 +195,8 @@ |
| 198 | 196 | /** |
| 199 | 197 | * Is this a local link from a sister project, or is |
| 200 | 198 | * it something outside, like Google |
| 201 | | - * @return bool |
| | 199 | + * |
| | 200 | + * @return Boolean |
| 202 | 201 | */ |
| 203 | 202 | public function isLocal() { |
| 204 | 203 | return $this->mLocal; |
| — | — | @@ -206,7 +205,8 @@ |
| 207 | 206 | /** |
| 208 | 207 | * Can pages from this wiki be transcluded? |
| 209 | 208 | * Still requires $wgEnableScaryTransclusion |
| 210 | | - * @return bool |
| | 209 | + * |
| | 210 | + * @return Boolean |
| 211 | 211 | */ |
| 212 | 212 | public function isTranscludable() { |
| 213 | 213 | return $this->mTrans; |
| — | — | @@ -214,6 +214,7 @@ |
| 215 | 215 | |
| 216 | 216 | /** |
| 217 | 217 | * Get the name for the interwiki site |
| | 218 | + * |
| 218 | 219 | * @return String |
| 219 | 220 | */ |
| 220 | 221 | public function getName() { |
| — | — | @@ -224,6 +225,7 @@ |
| 225 | 226 | |
| 226 | 227 | /** |
| 227 | 228 | * Get a description for this interwiki |
| | 229 | + * |
| 228 | 230 | * @return String |
| 229 | 231 | */ |
| 230 | 232 | public function getDescription() { |