| Index: trunk/phase3/maintenance/Doxyfile |
| — | — | @@ -290,7 +290,7 @@ |
| 291 | 291 | "string=\type{String}" \ |
| 292 | 292 | "str=\string" \ |
| 293 | 293 | "mixed=\type{Mixed}" \ |
| 294 | | - "access=\n<b> Access </b>:\n" \ |
| | 294 | + "access=\par Access:\n" \ |
| 295 | 295 | "private=\access private" \ |
| 296 | 296 | "protected=\access protected" \ |
| 297 | 297 | "public=\access public" |
| \ No newline at end of file |
| Index: trunk/phase3/includes/User.php |
| — | — | @@ -2278,8 +2278,8 @@ |
| 2279 | 2279 | * Set a cookie on the user's client. Wrapper for |
| 2280 | 2280 | * WebResponse::setCookie |
| 2281 | 2281 | * @param $name \string Name of the cookie to set |
| 2282 | | - * @param $name \string Value to set |
| 2283 | | - * @param $name \int Expiration time, as a UNIX time value; |
| | 2282 | + * @param $value \string Value to set |
| | 2283 | + * @param $exp \int Expiration time, as a UNIX time value; |
| 2284 | 2284 | * if 0 or not specified, use the default $wgCookieExpiration |
| 2285 | 2285 | */ |
| 2286 | 2286 | protected function setCookie( $name, $value, $exp=0 ) { |
| — | — | @@ -3249,13 +3249,13 @@ |
| 3250 | 3250 | static function crypt( $password, $salt = false ) { |
| 3251 | 3251 | global $wgPasswordSalt; |
| 3252 | 3252 | |
| 3253 | | - if($wgPasswordSalt) { |
| | 3253 | + if( $wgPasswordSalt ) { |
| 3254 | 3254 | if ( $salt === false ) { |
| 3255 | 3255 | $salt = substr( wfGenerateToken(), 0, 8 ); |
| 3256 | 3256 | } |
| 3257 | 3257 | return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) ); |
| 3258 | 3258 | } else { |
| 3259 | | - return ':A:' . md5( $password); |
| | 3259 | + return ':A:' . md5( $password ); |
| 3260 | 3260 | } |
| 3261 | 3261 | } |
| 3262 | 3262 | |
| — | — | @@ -3286,7 +3286,7 @@ |
| 3287 | 3287 | |
| 3288 | 3288 | /** |
| 3289 | 3289 | * Add a newuser log entry for this user |
| 3290 | | - * @param bool $byEmail, account made by email? |
| | 3290 | + * @param $byEmail Boolean: account made by email? |
| 3291 | 3291 | */ |
| 3292 | 3292 | public function addNewUserLogEntry( $byEmail = false ) { |
| 3293 | 3293 | global $wgUser, $wgContLang, $wgNewUserLog; |
| Index: trunk/phase3/includes/Article.php |
| — | — | @@ -175,9 +175,9 @@ |
| 176 | 176 | } |
| 177 | 177 | |
| 178 | 178 | /** |
| 179 | | - * Clear the object |
| 180 | | - * @private |
| 181 | | - */ |
| | 179 | + * Clear the object |
| | 180 | + * @private |
| | 181 | + */ |
| 182 | 182 | public function clear() { |
| 183 | 183 | $this->mDataLoaded = false; |
| 184 | 184 | $this->mContentLoaded = false; |
| — | — | @@ -306,8 +306,8 @@ |
| 307 | 307 | |
| 308 | 308 | /** |
| 309 | 309 | * Fetch a page record with the given conditions |
| 310 | | - * @param Database $dbr |
| 311 | | - * @param array $conditions |
| | 310 | + * @param $dbr Database object |
| | 311 | + * @param $conditions Array |
| 312 | 312 | */ |
| 313 | 313 | protected function pageData( $dbr, $conditions ) { |
| 314 | 314 | $fields = array( |
| — | — | @@ -335,8 +335,8 @@ |
| 336 | 336 | } |
| 337 | 337 | |
| 338 | 338 | /** |
| 339 | | - * @param Database $dbr |
| 340 | | - * @param Title $title |
| | 339 | + * @param $dbr Database object |
| | 340 | + * @param $title Title object |
| 341 | 341 | */ |
| 342 | 342 | public function pageDataFromTitle( $dbr, $title ) { |
| 343 | 343 | return $this->pageData( $dbr, array( |
| — | — | @@ -345,8 +345,8 @@ |
| 346 | 346 | } |
| 347 | 347 | |
| 348 | 348 | /** |
| 349 | | - * @param Database $dbr |
| 350 | | - * @param int $id |
| | 349 | + * @param $dbr Database |
| | 350 | + * @param $id Integer |
| 351 | 351 | */ |
| 352 | 352 | protected function pageDataFromId( $dbr, $id ) { |
| 353 | 353 | return $this->pageData( $dbr, array( 'page_id' => $id ) ); |
| — | — | @@ -356,7 +356,7 @@ |
| 357 | 357 | * Set the general counter, title etc data loaded from |
| 358 | 358 | * some source. |
| 359 | 359 | * |
| 360 | | - * @param object $data |
| | 360 | + * @param $data Database row object or "fromdb" |
| 361 | 361 | */ |
| 362 | 362 | public function loadPageData( $data = 'fromdb' ) { |
| 363 | 363 | if( $data === 'fromdb' ) { |
| — | — | @@ -390,7 +390,7 @@ |
| 391 | 391 | /** |
| 392 | 392 | * Get text of an article from database |
| 393 | 393 | * Does *NOT* follow redirects. |
| 394 | | - * @param int $oldid 0 for whatever the latest revision is |
| | 394 | + * @param $oldid Int: 0 for whatever the latest revision is |
| 395 | 395 | * @return string |
| 396 | 396 | */ |
| 397 | 397 | function fetchContent( $oldid = 0 ) { |
| — | — | @@ -972,9 +972,9 @@ |
| 973 | 973 | |
| 974 | 974 | /** |
| 975 | 975 | * View redirect |
| 976 | | - * @param Title $target Title of destination to redirect |
| 977 | | - * @param Bool $appendSubtitle [optional] |
| 978 | | - * @param Bool $forceKnown Should the image be shown as a bluelink regardless of existence? |
| | 976 | + * @param $target Title object of destination to redirect |
| | 977 | + * @param $appendSubtitle Boolean [optional] |
| | 978 | + * @param $forceKnown Boolean: should the image be shown as a bluelink regardless of existence? |
| 979 | 979 | */ |
| 980 | 980 | public function viewRedirect( $target, $appendSubtitle = true, $forceKnown = false ) { |
| 981 | 981 | global $wgParser, $wgOut, $wgContLang, $wgStylePath, $wgUser; |
| — | — | @@ -1110,8 +1110,8 @@ |
| 1111 | 1111 | * or else the record will be left in a funky state. |
| 1112 | 1112 | * Best if all done inside a transaction. |
| 1113 | 1113 | * |
| 1114 | | - * @param Database $dbw |
| 1115 | | - * @return int The newly created page_id key, or false if the title already existed |
| | 1114 | + * @param $dbw Database |
| | 1115 | + * @return int The newly created page_id key, or false if the title already existed |
| 1116 | 1116 | * @private |
| 1117 | 1117 | */ |
| 1118 | 1118 | public function insertOn( $dbw ) { |
| — | — | @@ -1144,15 +1144,15 @@ |
| 1145 | 1145 | /** |
| 1146 | 1146 | * Update the page record to point to a newly saved revision. |
| 1147 | 1147 | * |
| 1148 | | - * @param Database $dbw |
| 1149 | | - * @param Revision $revision For ID number, and text used to set |
| 1150 | | - length and redirect status fields |
| 1151 | | - * @param int $lastRevision If given, will not overwrite the page field |
| 1152 | | - * when different from the currently set value. |
| 1153 | | - * Giving 0 indicates the new page flag should |
| 1154 | | - * be set on. |
| 1155 | | - * @param bool $lastRevIsRedirect If given, will optimize adding and |
| 1156 | | - * removing rows in redirect table. |
| | 1148 | + * @param $dbw Database object |
| | 1149 | + * @param $revision Revision: For ID number, and text used to set |
| | 1150 | + length and redirect status fields |
| | 1151 | + * @param $lastRevision Integer: if given, will not overwrite the page field |
| | 1152 | + * when different from the currently set value. |
| | 1153 | + * Giving 0 indicates the new page flag should be set |
| | 1154 | + * on. |
| | 1155 | + * @param $lastRevIsRedirect Boolean: if given, will optimize adding and |
| | 1156 | + * removing rows in redirect table. |
| 1157 | 1157 | * @return bool true on success, false on failure |
| 1158 | 1158 | * @private |
| 1159 | 1159 | */ |
| — | — | @@ -1191,11 +1191,11 @@ |
| 1192 | 1192 | /** |
| 1193 | 1193 | * Add row to the redirect table if this is a redirect, remove otherwise. |
| 1194 | 1194 | * |
| 1195 | | - * @param Database $dbw |
| | 1195 | + * @param $dbw Database |
| 1196 | 1196 | * @param $redirectTitle a title object pointing to the redirect target, |
| 1197 | | - * or NULL if this is not a redirect |
| 1198 | | - * @param bool $lastRevIsRedirect If given, will optimize adding and |
| 1199 | | - * removing rows in redirect table. |
| | 1197 | + * or NULL if this is not a redirect |
| | 1198 | + * @param $lastRevIsRedirect If given, will optimize adding and |
| | 1199 | + * removing rows in redirect table. |
| 1200 | 1200 | * @return bool true on success, false on failure |
| 1201 | 1201 | * @private |
| 1202 | 1202 | */ |
| — | — | @@ -1232,8 +1232,8 @@ |
| 1233 | 1233 | * If the given revision is newer than the currently set page_latest, |
| 1234 | 1234 | * update the page record. Otherwise, do nothing. |
| 1235 | 1235 | * |
| 1236 | | - * @param Database $dbw |
| 1237 | | - * @param Revision $revision |
| | 1236 | + * @param $dbw Database object |
| | 1237 | + * @param $revision Revision object |
| 1238 | 1238 | */ |
| 1239 | 1239 | public function updateIfNewerOn( &$dbw, $revision ) { |
| 1240 | 1240 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -1376,9 +1376,9 @@ |
| 1377 | 1377 | * |
| 1378 | 1378 | * $wgUser must be set before calling this function. |
| 1379 | 1379 | * |
| 1380 | | - * @param string $text New text |
| 1381 | | - * @param string $summary Edit summary |
| 1382 | | - * @param integer $flags bitfield: |
| | 1380 | + * @param $text String: new text |
| | 1381 | + * @param $summary String: edit summary |
| | 1382 | + * @param $flags Integer bitfield: |
| 1383 | 1383 | * EDIT_NEW |
| 1384 | 1384 | * Article is known or assumed to be non-existent, create a new one |
| 1385 | 1385 | * EDIT_UPDATE |
| — | — | @@ -1400,7 +1400,8 @@ |
| 1401 | 1401 | * edit-already-exists error will be returned. These two conditions are also possible with |
| 1402 | 1402 | * auto-detection due to MediaWiki's performance-optimised locking strategy. |
| 1403 | 1403 | * |
| 1404 | | - * @param $baseRevId, the revision ID this edit was based off, if any |
| | 1404 | + * @param $baseRevId the revision ID this edit was based off, if any |
| | 1405 | + * @param $user Optional user object, $wgUser will be used if not passed |
| 1405 | 1406 | * |
| 1406 | 1407 | * @return Status object. Possible errors: |
| 1407 | 1408 | * edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status |
| — | — | @@ -1665,9 +1666,9 @@ |
| 1666 | 1667 | * Output a redirect back to the article. |
| 1667 | 1668 | * This is typically used after an edit. |
| 1668 | 1669 | * |
| 1669 | | - * @param boolean $noRedir Add redirect=no |
| 1670 | | - * @param string $sectionAnchor section to redirect to, including "#" |
| 1671 | | - * @param string $extraQuery, extra query params |
| | 1670 | + * @param $noRedir Boolean: add redirect=no |
| | 1671 | + * @param $sectionAnchor String: section to redirect to, including "#" |
| | 1672 | + * @param $extraQuery String: extra query params |
| 1672 | 1673 | */ |
| 1673 | 1674 | public function doRedirect( $noRedir = false, $sectionAnchor = '', $extraQuery = '' ) { |
| 1674 | 1675 | global $wgOut; |
| — | — | @@ -1824,8 +1825,10 @@ |
| 1825 | 1826 | /** |
| 1826 | 1827 | * Update the article's restriction field, and leave a log entry. |
| 1827 | 1828 | * |
| 1828 | | - * @param array $limit set of restriction keys |
| 1829 | | - * @param string $reason |
| | 1829 | + * @param $limit Array: set of restriction keys |
| | 1830 | + * @param $reason String |
| | 1831 | + * @param $cascade Integer |
| | 1832 | + * @param $expiry Array: per restriction type expiration |
| 1830 | 1833 | * @return bool true on success |
| 1831 | 1834 | */ |
| 1832 | 1835 | public function updateRestrictions( $limit = array(), $reason = '', $cascade = 0, $expiry = array() ) { |
| — | — | @@ -1965,8 +1968,8 @@ |
| 1966 | 1969 | /** |
| 1967 | 1970 | * Take an array of page restrictions and flatten it to a string |
| 1968 | 1971 | * suitable for insertion into the page_restrictions field. |
| 1969 | | - * @param array $limit |
| 1970 | | - * @return string |
| | 1972 | + * @param $limit Array |
| | 1973 | + * @return String |
| 1971 | 1974 | */ |
| 1972 | 1975 | protected static function flattenRestrictions( $limit ) { |
| 1973 | 1976 | if( !is_array( $limit ) ) { |
| — | — | @@ -1984,7 +1987,7 @@ |
| 1985 | 1988 | |
| 1986 | 1989 | /** |
| 1987 | 1990 | * Auto-generates a deletion reason |
| 1988 | | - * @param bool &$hasHistory Whether the page has a history |
| | 1991 | + * @param &$hasHistory Boolean: whether the page has a history |
| 1989 | 1992 | */ |
| 1990 | 1993 | public function generateReason( &$hasHistory ) { |
| 1991 | 1994 | global $wgContLang; |
| — | — | @@ -2171,8 +2174,8 @@ |
| 2172 | 2175 | |
| 2173 | 2176 | /** |
| 2174 | 2177 | * Get the last N authors |
| 2175 | | - * @param int $num Number of revisions to get |
| 2176 | | - * @param string $revLatest The latest rev_id, selected from the master (optional) |
| | 2178 | + * @param $num Integer: number of revisions to get |
| | 2179 | + * @param $revLatest String: the latest rev_id, selected from the master (optional) |
| 2177 | 2180 | * @return array Array of authors, duplicates not removed |
| 2178 | 2181 | */ |
| 2179 | 2182 | public function getLastNAuthors( $num, $revLatest = 0 ) { |
| — | — | @@ -2216,7 +2219,7 @@ |
| 2217 | 2220 | |
| 2218 | 2221 | /** |
| 2219 | 2222 | * Output deletion confirmation dialog |
| 2220 | | - * @param $reason string Prefilled reason |
| | 2223 | + * @param $reason String: prefilled reason |
| 2221 | 2224 | */ |
| 2222 | 2225 | public function confirmDelete( $reason ) { |
| 2223 | 2226 | global $wgOut, $wgUser; |
| — | — | @@ -2466,12 +2469,12 @@ |
| 2467 | 2470 | * performs permissions checks on $wgUser, then calls commitRollback() |
| 2468 | 2471 | * to do the dirty work |
| 2469 | 2472 | * |
| 2470 | | - * @param string $fromP - Name of the user whose edits to rollback. |
| 2471 | | - * @param string $summary - Custom summary. Set to default summary if empty. |
| 2472 | | - * @param string $token - Rollback token. |
| 2473 | | - * @param bool $bot - If true, mark all reverted edits as bot. |
| | 2473 | + * @param $fromP String: Name of the user whose edits to rollback. |
| | 2474 | + * @param $summary String: Custom summary. Set to default summary if empty. |
| | 2475 | + * @param $token String: Rollback token. |
| | 2476 | + * @param $bot Boolean: If true, mark all reverted edits as bot. |
| 2474 | 2477 | * |
| 2475 | | - * @param array $resultDetails contains result-specific array of additional values |
| | 2478 | + * @param $resultDetails Array: contains result-specific array of additional values |
| 2476 | 2479 | * 'alreadyrolled' : 'current' (rev) |
| 2477 | 2480 | * success : 'summary' (str), 'current' (rev), 'target' (rev) |
| 2478 | 2481 | * |
| — | — | @@ -2831,7 +2834,7 @@ |
| 2832 | 2835 | /** |
| 2833 | 2836 | * Perform article updates on a special page creation. |
| 2834 | 2837 | * |
| 2835 | | - * @param Revision $rev |
| | 2838 | + * @param $rev Revision object |
| 2836 | 2839 | * |
| 2837 | 2840 | * @todo This is a shitty interface function. Kill it and replace the |
| 2838 | 2841 | * other shitty functions like editUpdates and such so it's not needed |
| — | — | @@ -2850,7 +2853,7 @@ |
| 2851 | 2854 | * Revision as of \<date\>; view current revision |
| 2852 | 2855 | * \<- Previous version | Next Version -\> |
| 2853 | 2856 | * |
| 2854 | | - * @param string $oldid Revision ID of this article revision |
| | 2857 | + * @param $oldid String: revision ID of this article revision |
| 2855 | 2858 | */ |
| 2856 | 2859 | public function setOldSubtitle( $oldid=0 ) { |
| 2857 | 2860 | global $wgLang, $wgOut, $wgUser; |
| — | — | @@ -2924,7 +2927,7 @@ |
| 2925 | 2928 | * This function is called right before saving the wikitext, |
| 2926 | 2929 | * so we can do things like signatures and links-in-context. |
| 2927 | 2930 | * |
| 2928 | | - * @param string $text |
| | 2931 | + * @param $text String |
| 2929 | 2932 | */ |
| 2930 | 2933 | public function preSaveTransform( $text ) { |
| 2931 | 2934 | global $wgParser, $wgUser; |
| — | — | @@ -3033,9 +3036,9 @@ |
| 3034 | 3037 | * The article must already exist; link tables etc |
| 3035 | 3038 | * are not updated, caches are not flushed. |
| 3036 | 3039 | * |
| 3037 | | - * @param string $text text submitted |
| 3038 | | - * @param string $comment comment submitted |
| 3039 | | - * @param bool $minor whereas it's a minor modification |
| | 3040 | + * @param $text String: text submitted |
| | 3041 | + * @param $comment String: comment submitted |
| | 3042 | + * @param $minor Boolean: whereas it's a minor modification |
| 3040 | 3043 | */ |
| 3041 | 3044 | public function quickEdit( $text, $comment = '', $minor = 0 ) { |
| 3042 | 3045 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -3058,7 +3061,7 @@ |
| 3059 | 3062 | /** |
| 3060 | 3063 | * Used to increment the view counter |
| 3061 | 3064 | * |
| 3062 | | - * @param integer $id article id |
| | 3065 | + * @param $id Integer: article id |
| 3063 | 3066 | */ |
| 3064 | 3067 | public static function incViewCount( $id ) { |
| 3065 | 3068 | $id = intval( $id ); |
| — | — | @@ -3125,8 +3128,8 @@ |
| 3126 | 3129 | * This is a good place to put code to clear caches, for instance. |
| 3127 | 3130 | * |
| 3128 | 3131 | * This is called on page move and undelete, as well as edit |
| 3129 | | - * @static |
| 3130 | | - * @param $title_obj a title object |
| | 3132 | + * |
| | 3133 | + * @param $title a title object |
| 3131 | 3134 | */ |
| 3132 | 3135 | |
| 3133 | 3136 | public static function onArticleCreate( $title ) { |
| — | — | @@ -3217,8 +3220,6 @@ |
| 3218 | 3221 | /** |
| 3219 | 3222 | * Info about this page |
| 3220 | 3223 | * Called for ?action=info when $wgAllowPageInfo is on. |
| 3221 | | - * |
| 3222 | | - * @public |
| 3223 | 3224 | */ |
| 3224 | 3225 | public function info() { |
| 3225 | 3226 | global $wgLang, $wgOut, $wgAllowPageInfo, $wgUser; |
| — | — | @@ -3279,7 +3280,7 @@ |
| 3280 | 3281 | * Return the total number of edits and number of unique editors |
| 3281 | 3282 | * on a given page. If page does not exist, returns false. |
| 3282 | 3283 | * |
| 3283 | | - * @param Title $title |
| | 3284 | + * @param $title Title object |
| 3284 | 3285 | * @return array |
| 3285 | 3286 | */ |
| 3286 | 3287 | protected function pageCountInfo( $title ) { |
| — | — | @@ -3310,7 +3311,7 @@ |
| 3311 | 3312 | * Return a list of templates used by this article. |
| 3312 | 3313 | * Uses the templatelinks table |
| 3313 | 3314 | * |
| 3314 | | - * @return array Array of Title objects |
| | 3315 | + * @return Array of Title objects |
| 3315 | 3316 | */ |
| 3316 | 3317 | public function getUsedTemplates() { |
| 3317 | 3318 | $result = array(); |
| — | — | @@ -3336,7 +3337,7 @@ |
| 3337 | 3338 | * Returns a list of hidden categories this page is a member of. |
| 3338 | 3339 | * Uses the page_props and categorylinks tables. |
| 3339 | 3340 | * |
| 3340 | | - * @return array Array of Title objects |
| | 3341 | + * @return Array of Title objects |
| 3341 | 3342 | */ |
| 3342 | 3343 | public function getHiddenCategories() { |
| 3343 | 3344 | $result = array(); |
| — | — | @@ -3361,9 +3362,9 @@ |
| 3362 | 3363 | |
| 3363 | 3364 | /** |
| 3364 | 3365 | * Return an applicable autosummary if one exists for the given edit. |
| 3365 | | - * @param string $oldtext The previous text of the page. |
| 3366 | | - * @param string $newtext The submitted text of the page. |
| 3367 | | - * @param bitmask $flags A bitmask of flags submitted for the edit. |
| | 3366 | + * @param $oldtext String: the previous text of the page. |
| | 3367 | + * @param $newtext String: The submitted text of the page. |
| | 3368 | + * @param $flags Bitmask: a bitmask of flags submitted for the edit. |
| 3368 | 3369 | * @return string An appropriate autosummary, or an empty string. |
| 3369 | 3370 | */ |
| 3370 | 3371 | public static function getAutosummary( $oldtext, $newtext, $flags ) { |
| — | — | @@ -3411,8 +3412,8 @@ |
| 3412 | 3413 | * Saves the text into the parser cache if possible. |
| 3413 | 3414 | * Updates templatelinks if it is out of date. |
| 3414 | 3415 | * |
| 3415 | | - * @param string $text |
| 3416 | | - * @param bool $cache |
| | 3416 | + * @param $text String |
| | 3417 | + * @param $cache Boolean |
| 3417 | 3418 | */ |
| 3418 | 3419 | public function outputWikiText( $text, $cache = true ) { |
| 3419 | 3420 | global $wgParser, $wgUser, $wgOut, $wgEnableParserCache, $wgUseFileCache; |