| Index: trunk/phase3/maintenance/userDupes.inc |
| — | — | @@ -80,8 +80,8 @@ |
| 81 | 81 | * not requested. (If doing resolution, edits may be reassigned.) |
| 82 | 82 | * Status information will be echo'd to stdout. |
| 83 | 83 | * |
| 84 | | - * @param bool $doDelete pass true to actually remove things |
| 85 | | - * from the database; false to just check. |
| | 84 | + * @param $doDelete bool: pass true to actually remove things |
| | 85 | + * from the database; false to just check. |
| 86 | 86 | * @return bool |
| 87 | 87 | */ |
| 88 | 88 | function checkDupes( $doDelete = false ) { |
| — | — | @@ -202,8 +202,8 @@ |
| 203 | 203 | * Examine user records for the given name. Try to see which record |
| 204 | 204 | * will be the one that actually gets used, then check remaining records |
| 205 | 205 | * for edits. If the dupes have no edits, we can safely remove them. |
| 206 | | - * @param string $name |
| 207 | | - * @param bool $doDelete |
| | 206 | + * @param $name string |
| | 207 | + * @param $doDelete bool |
| 208 | 208 | * @access private |
| 209 | 209 | */ |
| 210 | 210 | function examine( $name, $doDelete ) { |
| — | — | @@ -253,7 +253,7 @@ |
| 254 | 254 | * Count the number of edits attributed to this user. |
| 255 | 255 | * Does not currently check log table or other things |
| 256 | 256 | * where it might show up... |
| 257 | | - * @param int $userid |
| | 257 | + * @param $userid int |
| 258 | 258 | * @return int |
| 259 | 259 | * @access private |
| 260 | 260 | */ |
| — | — | @@ -268,9 +268,9 @@ |
| 269 | 269 | |
| 270 | 270 | /** |
| 271 | 271 | * Count the number of hits on a given table for this account. |
| 272 | | - * @param string $table |
| 273 | | - * @param string $field |
| 274 | | - * @param int $userid |
| | 272 | + * @param $table string |
| | 273 | + * @param $field string |
| | 274 | + * @param $userid int |
| 275 | 275 | * @return int |
| 276 | 276 | * @access private |
| 277 | 277 | */ |
| — | — | @@ -284,8 +284,8 @@ |
| 285 | 285 | } |
| 286 | 286 | |
| 287 | 287 | /** |
| 288 | | - * @param int $from |
| 289 | | - * @param int $to |
| | 288 | + * @param $from int |
| | 289 | + * @param $to int |
| 290 | 290 | * @access private |
| 291 | 291 | */ |
| 292 | 292 | function reassignEdits( $from, $to ) { |
| — | — | @@ -298,10 +298,10 @@ |
| 299 | 299 | } |
| 300 | 300 | |
| 301 | 301 | /** |
| 302 | | - * @param string $table |
| 303 | | - * @param string $field |
| 304 | | - * @param int $from |
| 305 | | - * @param int $to |
| | 302 | + * @param $table string |
| | 303 | + * @param $field string |
| | 304 | + * @param $from int |
| | 305 | + * @param $to int |
| 306 | 306 | * @access private |
| 307 | 307 | */ |
| 308 | 308 | function reassignEditsOn( $table, $field, $from, $to ) { |
| — | — | @@ -316,7 +316,7 @@ |
| 317 | 317 | |
| 318 | 318 | /** |
| 319 | 319 | * Remove a user account line. |
| 320 | | - * @param int $userid |
| | 320 | + * @param $userid int |
| 321 | 321 | * @access private |
| 322 | 322 | */ |
| 323 | 323 | function trimAccount( $userid ) { |
| Index: trunk/phase3/includes/User.php |
| — | — | @@ -290,15 +290,14 @@ |
| 291 | 291 | * This is slightly less efficient than newFromId(), so use newFromId() if |
| 292 | 292 | * you have both an ID and a name handy. |
| 293 | 293 | * |
| 294 | | - * @param string $name Username, validated by Title:newFromText() |
| 295 | | - * @param mixed $validate Validate username. Takes the same parameters as |
| | 294 | + * @param $name String: username, validated by Title:newFromText() |
| | 295 | + * @param $validate Mixed: validate username. Takes the same parameters as |
| 296 | 296 | * User::getCanonicalName(), except that true is accepted as an alias |
| 297 | 297 | * for 'valid', for BC. |
| 298 | 298 | * |
| 299 | 299 | * @return User object, or null if the username is invalid. If the username |
| 300 | 300 | * is not present in the database, the result will be a user object with |
| 301 | 301 | * a name, zero user ID and default settings. |
| 302 | | - * @static |
| 303 | 302 | */ |
| 304 | 303 | static function newFromName( $name, $validate = 'valid' ) { |
| 305 | 304 | if ( $validate === true ) { |
| — | — | @@ -330,9 +329,8 @@ |
| 331 | 330 | * |
| 332 | 331 | * If the code is invalid or has expired, returns NULL. |
| 333 | 332 | * |
| 334 | | - * @param string $code |
| | 333 | + * @param $code string |
| 335 | 334 | * @return User |
| 336 | | - * @static |
| 337 | 335 | */ |
| 338 | 336 | static function newFromConfirmationCode( $code ) { |
| 339 | 337 | $dbr = wfGetDB( DB_SLAVE ); |
| — | — | @@ -352,7 +350,6 @@ |
| 353 | 351 | * login credentials are invalid, the result is an anonymous user. |
| 354 | 352 | * |
| 355 | 353 | * @return User |
| 356 | | - * @static |
| 357 | 354 | */ |
| 358 | 355 | static function newFromSession() { |
| 359 | 356 | $user = new User; |
| — | — | @@ -372,9 +369,8 @@ |
| 373 | 370 | |
| 374 | 371 | /** |
| 375 | 372 | * Get username given an id. |
| 376 | | - * @param integer $id Database user id |
| | 373 | + * @param $id Integer: database user id |
| 377 | 374 | * @return string Nickname of a user |
| 378 | | - * @static |
| 379 | 375 | */ |
| 380 | 376 | static function whoIs( $id ) { |
| 381 | 377 | $dbr = wfGetDB( DB_SLAVE ); |
| — | — | @@ -384,7 +380,7 @@ |
| 385 | 381 | /** |
| 386 | 382 | * Get the real name of a user given their identifier |
| 387 | 383 | * |
| 388 | | - * @param int $id Database user id |
| | 384 | + * @param $id Int: database user id |
| 389 | 385 | * @return string Real name of a user |
| 390 | 386 | */ |
| 391 | 387 | static function whoIsReal( $id ) { |
| — | — | @@ -394,7 +390,7 @@ |
| 395 | 391 | |
| 396 | 392 | /** |
| 397 | 393 | * Get database id given a user name |
| 398 | | - * @param string $name Nickname of a user |
| | 394 | + * @param $name String: nickname of a user |
| 399 | 395 | * @return integer|null Database user id (null: if non existent |
| 400 | 396 | * @static |
| 401 | 397 | */ |
| — | — | @@ -427,8 +423,7 @@ |
| 428 | 424 | * addresses like this, if we allowed accounts like this to be created |
| 429 | 425 | * new users could get the old edits of these anonymous users. |
| 430 | 426 | * |
| 431 | | - * @static |
| 432 | | - * @param string $name Nickname of a user |
| | 427 | + * @param $name String: nickname of a user |
| 433 | 428 | * @return bool |
| 434 | 429 | */ |
| 435 | 430 | static function isIP( $name ) { |
| — | — | @@ -443,9 +438,8 @@ |
| 444 | 439 | * is longer than the maximum allowed username size or doesn't begin with |
| 445 | 440 | * a capital letter. |
| 446 | 441 | * |
| 447 | | - * @param string $name |
| | 442 | + * @param $name string |
| 448 | 443 | * @return bool |
| 449 | | - * @static |
| 450 | 444 | */ |
| 451 | 445 | static function isValidUserName( $name ) { |
| 452 | 446 | global $wgContLang, $wgMaxNameChars; |
| — | — | @@ -498,7 +492,7 @@ |
| 499 | 493 | * If an account already exists in this form, login will be blocked |
| 500 | 494 | * by a failure to pass this function. |
| 501 | 495 | * |
| 502 | | - * @param string $name |
| | 496 | + * @param $name string |
| 503 | 497 | * @return bool |
| 504 | 498 | */ |
| 505 | 499 | static function isUsableName( $name ) { |
| — | — | @@ -521,7 +515,7 @@ |
| 522 | 516 | * rather than in isValidUserName() to avoid disrupting |
| 523 | 517 | * existing accounts. |
| 524 | 518 | * |
| 525 | | - * @param string $name |
| | 519 | + * @param $name string |
| 526 | 520 | * @return bool |
| 527 | 521 | */ |
| 528 | 522 | static function isCreatableName( $name ) { |
| — | — | @@ -535,7 +529,7 @@ |
| 536 | 530 | /** |
| 537 | 531 | * Is the input a valid password for this user? |
| 538 | 532 | * |
| 539 | | - * @param string $password Desired password |
| | 533 | + * @param $password String: desired password |
| 540 | 534 | * @return bool |
| 541 | 535 | */ |
| 542 | 536 | function isValidPassword( $password ) { |
| — | — | @@ -561,7 +555,7 @@ |
| 562 | 556 | * |
| 563 | 557 | * @todo Check for RFC 2822 compilance (bug 959) |
| 564 | 558 | * |
| 565 | | - * @param string $addr email address |
| | 559 | + * @param $addr String: email address |
| 566 | 560 | * @return bool |
| 567 | 561 | */ |
| 568 | 562 | public static function isValidEmailAddr( $addr ) { |
| — | — | @@ -576,12 +570,12 @@ |
| 577 | 571 | /** |
| 578 | 572 | * Given unvalidated user input, return a canonical username, or false if |
| 579 | 573 | * the username is invalid. |
| 580 | | - * @param string $name |
| 581 | | - * @param mixed $validate Type of validation to use: |
| 582 | | - * false No validation |
| 583 | | - * 'valid' Valid for batch processes |
| 584 | | - * 'usable' Valid for batch processes and login |
| 585 | | - * 'creatable' Valid for batch processes, login and account creation |
| | 574 | + * @param $name string |
| | 575 | + * @param $validate Mixed: type of validation to use: |
| | 576 | + * false No validation |
| | 577 | + * 'valid' Valid for batch processes |
| | 578 | + * 'usable' Valid for batch processes and login |
| | 579 | + * 'creatable' Valid for batch processes, login and account creation |
| 586 | 580 | */ |
| 587 | 581 | static function getCanonicalName( $name, $validate = 'valid' ) { |
| 588 | 582 | # Force usernames to capital |
| — | — | @@ -634,9 +628,8 @@ |
| 635 | 629 | * |
| 636 | 630 | * It should not be static and some day should be merged as proper member function / deprecated -- domas |
| 637 | 631 | * |
| 638 | | - * @param int $uid The user ID to check |
| | 632 | + * @param $uid Int: the user ID to check |
| 639 | 633 | * @return int |
| 640 | | - * @static |
| 641 | 634 | */ |
| 642 | 635 | static function edits( $uid ) { |
| 643 | 636 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -673,7 +666,6 @@ |
| 674 | 667 | * @todo hash random numbers to improve security, like generateToken() |
| 675 | 668 | * |
| 676 | 669 | * @return string |
| 677 | | - * @static |
| 678 | 670 | */ |
| 679 | 671 | static function randomPassword() { |
| 680 | 672 | global $wgMinimalPasswordLength; |
| — | — | @@ -883,7 +875,7 @@ |
| 884 | 876 | |
| 885 | 877 | /** |
| 886 | 878 | * Clear various cached data stored in this object. |
| 887 | | - * @param string $reloadFrom Reload user and user_groups table data from a |
| | 879 | + * @param $reloadFrom String: reload user and user_groups table data from a |
| 888 | 880 | * given source. May be "name", "id", "defaults", "session" or false for |
| 889 | 881 | * no reload. |
| 890 | 882 | */ |
| — | — | @@ -907,7 +899,6 @@ |
| 908 | 900 | * and add the default language variants. |
| 909 | 901 | * Not really private cause it's called by Language class |
| 910 | 902 | * @return array |
| 911 | | - * @static |
| 912 | 903 | * @private |
| 913 | 904 | */ |
| 914 | 905 | static function getDefaultOptions() { |
| — | — | @@ -934,7 +925,7 @@ |
| 935 | 926 | /** |
| 936 | 927 | * Get a given default option value. |
| 937 | 928 | * |
| 938 | | - * @param string $opt |
| | 929 | + * @param $opt string |
| 939 | 930 | * @return string |
| 940 | 931 | */ |
| 941 | 932 | public static function getDefaultOption( $opt ) { |
| — | — | @@ -961,9 +952,10 @@ |
| 962 | 953 | /** |
| 963 | 954 | * Get blocking information |
| 964 | 955 | * @private |
| 965 | | - * @param bool $bFromSlave Specify whether to check slave or master. To improve performance, |
| 966 | | - * non-critical checks are done against slaves. Check when actually saving should be done against |
| 967 | | - * master. |
| | 956 | + * @param $bFromSlave Bool: specify whether to check slave or master. To |
| | 957 | + * improve performance, non-critical checks are done |
| | 958 | + * against slaves. Check when actually saving should be |
| | 959 | + * done against master. |
| 968 | 960 | */ |
| 969 | 961 | function getBlockedStatus( $bFromSlave = true ) { |
| 970 | 962 | global $wgEnableSorbs, $wgProxyWhitelist; |
| — | — | @@ -1089,7 +1081,6 @@ |
| 1090 | 1082 | * last-hit counters will be shared across wikis. |
| 1091 | 1083 | * |
| 1092 | 1084 | * @return bool true if a rate limiter was tripped |
| 1093 | | - * @public |
| 1094 | 1085 | */ |
| 1095 | 1086 | function pingLimiter( $action='edit' ) { |
| 1096 | 1087 | |
| — | — | @@ -1286,7 +1277,6 @@ |
| 1287 | 1278 | /** |
| 1288 | 1279 | * Return the title dbkey form of the name, for eg user pages. |
| 1289 | 1280 | * @return string |
| 1290 | | - * @public |
| 1291 | 1281 | */ |
| 1292 | 1282 | function getTitleKey() { |
| 1293 | 1283 | return str_replace( ' ', '_', $this->getName() ); |
| — | — | @@ -1341,9 +1331,9 @@ |
| 1342 | 1332 | * Perform a user_newtalk check, uncached. |
| 1343 | 1333 | * Use getNewtalk for a cached check. |
| 1344 | 1334 | * |
| 1345 | | - * @param string $field |
| 1346 | | - * @param mixed $id |
| 1347 | | - * @param bool $fromMaster True to fetch from the master, false for a slave |
| | 1335 | + * @param $field string |
| | 1336 | + * @param $id mixed |
| | 1337 | + * @param $fromMaster Bool: true to fetch from the master, false for a slave |
| 1348 | 1338 | * @return bool |
| 1349 | 1339 | * @private |
| 1350 | 1340 | */ |
| — | — | @@ -1360,8 +1350,8 @@ |
| 1361 | 1351 | |
| 1362 | 1352 | /** |
| 1363 | 1353 | * Add or update the |
| 1364 | | - * @param string $field |
| 1365 | | - * @param mixed $id |
| | 1354 | + * @param $field string |
| | 1355 | + * @param $id mixed |
| 1366 | 1356 | * @private |
| 1367 | 1357 | */ |
| 1368 | 1358 | function updateNewtalk( $field, $id ) { |
| — | — | @@ -1381,8 +1371,8 @@ |
| 1382 | 1372 | |
| 1383 | 1373 | /** |
| 1384 | 1374 | * Clear the new messages flag for the given user |
| 1385 | | - * @param string $field |
| 1386 | | - * @param mixed $id |
| | 1375 | + * @param $field string |
| | 1376 | + * @param $id mixed |
| 1387 | 1377 | * @private |
| 1388 | 1378 | */ |
| 1389 | 1379 | function deleteNewtalk( $field, $id ) { |
| — | — | @@ -1401,7 +1391,7 @@ |
| 1402 | 1392 | |
| 1403 | 1393 | /** |
| 1404 | 1394 | * Update the 'You have new messages!' status. |
| 1405 | | - * @param bool $val |
| | 1395 | + * @param $val bool |
| 1406 | 1396 | */ |
| 1407 | 1397 | function setNewtalk( $val ) { |
| 1408 | 1398 | if( wfReadOnly() ) { |
| — | — | @@ -1496,7 +1486,7 @@ |
| 1497 | 1487 | * wipes it, so the account cannot be logged in until |
| 1498 | 1488 | * a new password is set, for instance via e-mail. |
| 1499 | 1489 | * |
| 1500 | | - * @param string $str |
| | 1490 | + * @param $str string |
| 1501 | 1491 | * @throws PasswordError on failure |
| 1502 | 1492 | */ |
| 1503 | 1493 | function setPassword( $str ) { |
| — | — | @@ -1527,7 +1517,7 @@ |
| 1528 | 1518 | * Set the password and reset the random token no matter |
| 1529 | 1519 | * what. |
| 1530 | 1520 | * |
| 1531 | | - * @param string $str |
| | 1521 | + * @param $str string |
| 1532 | 1522 | */ |
| 1533 | 1523 | function setInternalPassword( $str ) { |
| 1534 | 1524 | $this->load(); |
| — | — | @@ -1630,8 +1620,8 @@ |
| 1631 | 1621 | } |
| 1632 | 1622 | |
| 1633 | 1623 | /** |
| 1634 | | - * @param string $oname The option to check |
| 1635 | | - * @param string $defaultOverride A default value returned if the option does not exist |
| | 1624 | + * @param $oname String: the option to check |
| | 1625 | + * @param $defaultOverride String: A default value returned if the option does not exist |
| 1636 | 1626 | * @return string |
| 1637 | 1627 | */ |
| 1638 | 1628 | function getOption( $oname, $defaultOverride = '' ) { |
| — | — | @@ -1669,7 +1659,7 @@ |
| 1670 | 1660 | } |
| 1671 | 1661 | |
| 1672 | 1662 | /** |
| 1673 | | - * @param string $oname The option to check |
| | 1663 | + * @param $oname String: the option to check |
| 1674 | 1664 | * @return bool False if the option is not selected, true if it is |
| 1675 | 1665 | */ |
| 1676 | 1666 | function getBoolOption( $oname ) { |
| — | — | @@ -1678,8 +1668,8 @@ |
| 1679 | 1669 | |
| 1680 | 1670 | /** |
| 1681 | 1671 | * Get an option as an integer value from the source string. |
| 1682 | | - * @param string $oname The option to check |
| 1683 | | - * @param int $default Optional value to return if option is unset/blank. |
| | 1672 | + * @param $oname String: the option to check |
| | 1673 | + * @param $default Int: optional value to return if option is unset/blank. |
| 1684 | 1674 | * @return int |
| 1685 | 1675 | */ |
| 1686 | 1676 | function getIntOption( $oname, $default=0 ) { |
| — | — | @@ -1738,7 +1728,7 @@ |
| 1739 | 1729 | * Get the list of implicit group memberships this user has. |
| 1740 | 1730 | * This includes all explicit groups, plus 'user' if logged in, |
| 1741 | 1731 | * '*' for all accounts and autopromoted groups |
| 1742 | | - * @param boolean $recache Don't use the cache |
| | 1732 | + * @param $recache Boolean: don't use the cache |
| 1743 | 1733 | * @return array of strings |
| 1744 | 1734 | */ |
| 1745 | 1735 | function getEffectiveGroups( $recache = false ) { |
| — | — | @@ -1777,7 +1767,7 @@ |
| 1778 | 1768 | /** |
| 1779 | 1769 | * Add the user to the given group. |
| 1780 | 1770 | * This takes immediate effect. |
| 1781 | | - * @param string $group |
| | 1771 | + * @param $group string |
| 1782 | 1772 | */ |
| 1783 | 1773 | function addGroup( $group ) { |
| 1784 | 1774 | $dbw = wfGetDB( DB_MASTER ); |
| — | — | @@ -1801,7 +1791,7 @@ |
| 1802 | 1792 | /** |
| 1803 | 1793 | * Remove the user from the given group. |
| 1804 | 1794 | * This takes immediate effect. |
| 1805 | | - * @param string $group |
| | 1795 | + * @param $group string |
| 1806 | 1796 | */ |
| 1807 | 1797 | function removeGroup( $group ) { |
| 1808 | 1798 | $this->load(); |
| — | — | @@ -1852,7 +1842,7 @@ |
| 1853 | 1843 | |
| 1854 | 1844 | /** |
| 1855 | 1845 | * Check if user is allowed to access a feature / make an action |
| 1856 | | - * @param string $action Action to be checked |
| | 1846 | + * @param $action String: action to be checked |
| 1857 | 1847 | * @return boolean True: action is allowed, False: action should not be allowed |
| 1858 | 1848 | */ |
| 1859 | 1849 | function isAllowed($action='') { |
| — | — | @@ -1901,7 +1891,7 @@ |
| 1902 | 1892 | } |
| 1903 | 1893 | |
| 1904 | 1894 | /**#@+ |
| 1905 | | - * @param string $title Article title to look at |
| | 1895 | + * @param $title Title: article title to look at |
| 1906 | 1896 | */ |
| 1907 | 1897 | |
| 1908 | 1898 | /** |
| — | — | @@ -1985,7 +1975,7 @@ |
| 1986 | 1976 | 'wl_title' => $title->getDBkey(), |
| 1987 | 1977 | 'wl_namespace' => $title->getNamespace(), |
| 1988 | 1978 | 'wl_user' => $this->getID() |
| 1989 | | - ), 'User::clearLastVisited' |
| | 1979 | + ), __METHOD__ |
| 1990 | 1980 | ); |
| 1991 | 1981 | } |
| 1992 | 1982 | } |
| — | — | @@ -1997,8 +1987,7 @@ |
| 1998 | 1988 | * If e-notif e-mails are on, they will receive notification mails on |
| 1999 | 1989 | * the next change of any watched page. |
| 2000 | 1990 | * |
| 2001 | | - * @param int $currentUser user ID number |
| 2002 | | - * @public |
| | 1991 | + * @param $currentUser Int: user ID number |
| 2003 | 1992 | */ |
| 2004 | 1993 | function clearAllNotifications( $currentUser ) { |
| 2005 | 1994 | global $wgUseEnotif, $wgShowUpdatedMarker; |
| — | — | @@ -2198,8 +2187,8 @@ |
| 2199 | 2188 | /** |
| 2200 | 2189 | * Add a user to the database, return the user object |
| 2201 | 2190 | * |
| 2202 | | - * @param string $name The user's name |
| 2203 | | - * @param array $params Associative array of non-default parameters to save to the database: |
| | 2191 | + * @param $name String: the user's name |
| | 2192 | + * @param $params Associative array of non-default parameters to save to the database: |
| 2204 | 2193 | * password The user's password. Password logins will be disabled if this is omitted. |
| 2205 | 2194 | * newpassword A temporary password mailed to the user |
| 2206 | 2195 | * email The user's email address |
| — | — | @@ -2347,7 +2336,6 @@ |
| 2348 | 2337 | /** |
| 2349 | 2338 | * Determine if the user is blocked from using Special:Emailuser. |
| 2350 | 2339 | * |
| 2351 | | - * @public |
| 2352 | 2340 | * @return boolean |
| 2353 | 2341 | */ |
| 2354 | 2342 | function isBlockedFromEmailuser() { |
| — | — | @@ -2370,7 +2358,6 @@ |
| 2371 | 2359 | * Get this user's personal page title. |
| 2372 | 2360 | * |
| 2373 | 2361 | * @return Title |
| 2374 | | - * @public |
| 2375 | 2362 | */ |
| 2376 | 2363 | function getUserPage() { |
| 2377 | 2364 | return Title::makeTitle( NS_USER, $this->getName() ); |
| — | — | @@ -2380,7 +2367,6 @@ |
| 2381 | 2368 | * Get this user's talk page title. |
| 2382 | 2369 | * |
| 2383 | 2370 | * @return Title |
| 2384 | | - * @public |
| 2385 | 2371 | */ |
| 2386 | 2372 | function getTalkPage() { |
| 2387 | 2373 | $title = $this->getUserPage(); |
| — | — | @@ -2438,7 +2424,7 @@ |
| 2439 | 2425 | |
| 2440 | 2426 | /** |
| 2441 | 2427 | * Check to see if the given clear-text password is one of the accepted passwords |
| 2442 | | - * @param string $password User password. |
| | 2428 | + * @param $password String: user password. |
| 2443 | 2429 | * @return bool True if the given password is correct otherwise False. |
| 2444 | 2430 | */ |
| 2445 | 2431 | function checkPassword( $password ) { |
| — | — | @@ -2491,10 +2477,9 @@ |
| 2492 | 2478 | * login credentials aren't being hijacked with a foreign form |
| 2493 | 2479 | * submission. |
| 2494 | 2480 | * |
| 2495 | | - * @param mixed $salt - Optional function-specific data for hash. |
| 2496 | | - * Use a string or an array of strings. |
| | 2481 | + * @param $salt Mixed: optional function-specific data for hash. |
| | 2482 | + * Use a string or an array of strings. |
| 2497 | 2483 | * @return string |
| 2498 | | - * @public |
| 2499 | 2484 | */ |
| 2500 | 2485 | function editToken( $salt = '' ) { |
| 2501 | 2486 | if ( $this->isAnon() ) { |
| — | — | @@ -2529,10 +2514,9 @@ |
| 2530 | 2515 | * user's own login session, not a form submission from a third-party |
| 2531 | 2516 | * site. |
| 2532 | 2517 | * |
| 2533 | | - * @param string $val - the input value to compare |
| 2534 | | - * @param string $salt - Optional function-specific data for hash |
| | 2518 | + * @param $val String: the input value to compare |
| | 2519 | + * @param $salt String: optional function-specific data for hash |
| 2535 | 2520 | * @return bool |
| 2536 | | - * @public |
| 2537 | 2521 | */ |
| 2538 | 2522 | function matchEditToken( $val, $salt = '' ) { |
| 2539 | 2523 | $sessionToken = $this->editToken( $salt ); |
| — | — | @@ -2580,9 +2564,10 @@ |
| 2581 | 2565 | * Send an e-mail to this user's account. Does not check for |
| 2582 | 2566 | * confirmed status or validity. |
| 2583 | 2567 | * |
| 2584 | | - * @param string $subject |
| 2585 | | - * @param string $body |
| 2586 | | - * @param string $from Optional from address; default $wgPasswordSender will be used otherwise. |
| | 2568 | + * @param $subject string |
| | 2569 | + * @param $body string |
| | 2570 | + * @param $from string: optional from address; default $wgPasswordSender will be used otherwise. |
| | 2571 | + * @param $replyto string |
| 2587 | 2572 | * @return mixed True on success, a WikiError object on failure. |
| 2588 | 2573 | */ |
| 2589 | 2574 | function sendMail( $subject, $body, $from = null, $replyto = null ) { |
| — | — | @@ -2621,7 +2606,7 @@ |
| 2622 | 2607 | |
| 2623 | 2608 | /** |
| 2624 | 2609 | * Return a URL the user can use to confirm their email address. |
| 2625 | | - * @param $token: accepts the email confirmation token |
| | 2610 | + * @param $token accepts the email confirmation token |
| 2626 | 2611 | * @return string |
| 2627 | 2612 | * @private |
| 2628 | 2613 | */ |
| — | — | @@ -2630,7 +2615,7 @@ |
| 2631 | 2616 | } |
| 2632 | 2617 | /** |
| 2633 | 2618 | * Return a URL the user can use to invalidate their email address. |
| 2634 | | - * @param $token: accepts the email confirmation token |
| | 2619 | + * @param $token accepts the email confirmation token |
| 2635 | 2620 | * @return string |
| 2636 | 2621 | * @private |
| 2637 | 2622 | */ |
| — | — | @@ -2759,7 +2744,7 @@ |
| 2760 | 2745 | } |
| 2761 | 2746 | |
| 2762 | 2747 | /** |
| 2763 | | - * @param array $groups list of groups |
| | 2748 | + * @param $groups Array: list of groups |
| 2764 | 2749 | * @return array list of permission key names for given groups combined |
| 2765 | 2750 | */ |
| 2766 | 2751 | static function getGroupPermissions( $groups ) { |
| — | — | @@ -2775,7 +2760,7 @@ |
| 2776 | 2761 | } |
| 2777 | 2762 | |
| 2778 | 2763 | /** |
| 2779 | | - * @param string $group key name |
| | 2764 | + * @param $group String: key name |
| 2780 | 2765 | * @return string localized descriptive name for group, if provided |
| 2781 | 2766 | */ |
| 2782 | 2767 | static function getGroupName( $group ) { |
| — | — | @@ -2789,7 +2774,7 @@ |
| 2790 | 2775 | } |
| 2791 | 2776 | |
| 2792 | 2777 | /** |
| 2793 | | - * @param string $group key name |
| | 2778 | + * @param $group String: key name |
| 2794 | 2779 | * @return string localized descriptive name for member of a group, if provided |
| 2795 | 2780 | */ |
| 2796 | 2781 | static function getGroupMember( $group ) { |
| — | — | @@ -2961,8 +2946,8 @@ |
| 2962 | 2947 | /** |
| 2963 | 2948 | * Make an old-style password hash |
| 2964 | 2949 | * |
| 2965 | | - * @param string $password Plain-text password |
| 2966 | | - * @param string $userId User ID |
| | 2950 | + * @param $password String: plain-text password |
| | 2951 | + * @param $userId String: user ID |
| 2967 | 2952 | */ |
| 2968 | 2953 | static function oldCrypt( $password, $userId ) { |
| 2969 | 2954 | global $wgPasswordSalt; |
| — | — | @@ -2976,8 +2961,8 @@ |
| 2977 | 2962 | /** |
| 2978 | 2963 | * Make a new-style password hash |
| 2979 | 2964 | * |
| 2980 | | - * @param string $password Plain-text password |
| 2981 | | - * @param string $salt Salt, may be random or the user ID. False to generate a salt. |
| | 2965 | + * @param $password String: plain-text password |
| | 2966 | + * @param $salt String: salt, may be random or the user ID. False to generate a salt. |
| 2982 | 2967 | */ |
| 2983 | 2968 | static function crypt( $password, $salt = false ) { |
| 2984 | 2969 | global $wgPasswordSalt; |
| — | — | @@ -2996,9 +2981,9 @@ |
| 2997 | 2982 | * Compare a password hash with a plain-text password. Requires the user |
| 2998 | 2983 | * ID if there's a chance that the hash is an old-style hash. |
| 2999 | 2984 | * |
| 3000 | | - * @param string $hash Password hash |
| 3001 | | - * @param string $password Plain-text password to compare |
| 3002 | | - * @param string $userId User ID for old-style password salt |
| | 2985 | + * @param $hash String: password hash |
| | 2986 | + * @param $password String: plain-text password to compare |
| | 2987 | + * @param $userId String: user ID for old-style password salt |
| 3003 | 2988 | */ |
| 3004 | 2989 | static function comparePasswords( $hash, $password, $userId = false ) { |
| 3005 | 2990 | $m = false; |
| Index: trunk/phase3/includes/UserMailer.php |
| — | — | @@ -29,8 +29,8 @@ |
| 30 | 30 | */ |
| 31 | 31 | class MailAddress { |
| 32 | 32 | /** |
| 33 | | - * @param mixed $address String with an email address, or a User object |
| 34 | | - * @param string $name Human-readable name if a string address is given |
| | 33 | + * @param $address Mixed: string with an email address, or a User object |
| | 34 | + * @param $name String: human-readable name if a string address is given |
| 35 | 35 | */ |
| 36 | 36 | function __construct( $address, $name=null ) { |
| 37 | 37 | if( is_object( $address ) && $address instanceof User ) { |
| Index: trunk/phase3/includes/AjaxFunctions.php |
| — | — | @@ -75,7 +75,7 @@ |
| 76 | 76 | define( 'AJAX_SEARCH_VERSION', 2 ); //AJAX search cache version |
| 77 | 77 | |
| 78 | 78 | function wfSajaxSearch( $term ) { |
| 79 | | - global $wgContLang, $wgOut, $wgUser, $wgCapitalLinks, $wgMemc; |
| | 79 | + global $wgContLang, $wgUser, $wgCapitalLinks, $wgMemc; |
| 80 | 80 | $limit = 16; |
| 81 | 81 | $sk = $wgUser->getSkin(); |
| 82 | 82 | $output = ''; |