| Index: trunk/phase3/maintenance/Doxyfile |
| — | — | @@ -16,7 +16,7 @@ |
| 17 | 17 | PROJECT_NAME = MediaWiki |
| 18 | 18 | PROJECT_NUMBER = {{CURRENT_VERSION}} |
| 19 | 19 | OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}} |
| 20 | | -CREATE_SUBDIRS = NO |
| | 20 | +CREATE_SUBDIRS = YES |
| 21 | 21 | OUTPUT_LANGUAGE = English |
| 22 | 22 | BRIEF_MEMBER_DESC = YES |
| 23 | 23 | REPEAT_BRIEF = YES |
| — | — | @@ -175,7 +175,7 @@ |
| 176 | 176 | HHC_LOCATION = |
| 177 | 177 | GENERATE_CHI = NO |
| 178 | 178 | BINARY_TOC = NO |
| 179 | | -TOC_EXPAND = NO |
| | 179 | +TOC_EXPAND = YES |
| 180 | 180 | DISABLE_INDEX = NO |
| 181 | 181 | ENUM_VALUES_PER_LINE = 4 |
| 182 | 182 | GENERATE_TREEVIEW = YES |
| — | — | @@ -191,8 +191,8 @@ |
| 192 | 192 | PAPER_TYPE = a4wide |
| 193 | 193 | EXTRA_PACKAGES = |
| 194 | 194 | LATEX_HEADER = |
| 195 | | -PDF_HYPERLINKS = NO |
| 196 | | -USE_PDFLATEX = NO |
| | 195 | +PDF_HYPERLINKS = YES |
| | 196 | +USE_PDFLATEX = YES |
| 197 | 197 | LATEX_BATCHMODE = NO |
| 198 | 198 | LATEX_HIDE_INDICES = NO |
| 199 | 199 | #--------------------------------------------------------------------------- |
| — | — | @@ -207,7 +207,7 @@ |
| 208 | 208 | #--------------------------------------------------------------------------- |
| 209 | 209 | # configuration options related to the man page output |
| 210 | 210 | #--------------------------------------------------------------------------- |
| 211 | | -GENERATE_MAN = YES |
| | 211 | +GENERATE_MAN = NO |
| 212 | 212 | MAN_OUTPUT = man |
| 213 | 213 | MAN_EXTENSION = .3 |
| 214 | 214 | MAN_LINKS = NO |
| Index: trunk/phase3/includes/User.php |
| — | — | @@ -461,8 +461,8 @@ |
| 462 | 462 | * addresses like this, if we allowed accounts like this to be created |
| 463 | 463 | * new users could get the old edits of these anonymous users. |
| 464 | 464 | * |
| 465 | | - * @param $name \type{\string} |
| 466 | | - * @return \type{\bool} |
| | 465 | + * @param $name \type{\string} String to match |
| | 466 | + * @return \type{\bool} True or false |
| 467 | 467 | */ |
| 468 | 468 | static function isIP( $name ) { |
| 469 | 469 | return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP::isIPv6($name); |
| — | — | @@ -476,8 +476,8 @@ |
| 477 | 477 | * is longer than the maximum allowed username size or doesn't begin with |
| 478 | 478 | * a capital letter. |
| 479 | 479 | * |
| 480 | | - * @param $name \type{\string} |
| 481 | | - * @return \type{\bool} |
| | 480 | + * @param $name \type{\string} String to match |
| | 481 | + * @return \type{\bool} True or false |
| 482 | 482 | */ |
| 483 | 483 | static function isValidUserName( $name ) { |
| 484 | 484 | global $wgContLang, $wgMaxNameChars; |
| — | — | @@ -530,8 +530,8 @@ |
| 531 | 531 | * If an account already exists in this form, login will be blocked |
| 532 | 532 | * by a failure to pass this function. |
| 533 | 533 | * |
| 534 | | - * @param $name \type{\string} |
| 535 | | - * @return \type{\bool} |
| | 534 | + * @param $name \type{\string} String to match |
| | 535 | + * @return \type{\bool} True or false |
| 536 | 536 | */ |
| 537 | 537 | static function isUsableName( $name ) { |
| 538 | 538 | global $wgReservedUsernames; |
| — | — | @@ -568,8 +568,8 @@ |
| 569 | 569 | * rather than in isValidUserName() to avoid disrupting |
| 570 | 570 | * existing accounts. |
| 571 | 571 | * |
| 572 | | - * @param $name \type{\string} |
| 573 | | - * @return \type{\bool} |
| | 572 | + * @param $name \type{\string} String to match |
| | 573 | + * @return \type{\bool} True or false |
| 574 | 574 | */ |
| 575 | 575 | static function isCreatableName( $name ) { |
| 576 | 576 | return |
| — | — | @@ -583,7 +583,7 @@ |
| 584 | 584 | * Is the input a valid password for this user? |
| 585 | 585 | * |
| 586 | 586 | * @param $password \type{\string} Desired password |
| 587 | | - * @return \type{\bool} |
| | 587 | + * @return \type{\bool} True or false |
| 588 | 588 | */ |
| 589 | 589 | function isValidPassword( $password ) { |
| 590 | 590 | global $wgMinimalPasswordLength, $wgContLang; |
| — | — | @@ -609,7 +609,7 @@ |
| 610 | 610 | * @todo Check for RFC 2822 compilance (bug 959) |
| 611 | 611 | * |
| 612 | 612 | * @param $addr \type{\string} E-mail address |
| 613 | | - * @return \type{\bool} |
| | 613 | + * @return \type{\bool} True or false |
| 614 | 614 | */ |
| 615 | 615 | public static function isValidEmailAddr( $addr ) { |
| 616 | 616 | $result = null; |
| — | — | @@ -717,7 +717,7 @@ |
| 718 | 718 | * Return a random password. Sourced from mt_rand, so it's not particularly secure. |
| 719 | 719 | * @todo hash random numbers to improve security, like generateToken() |
| 720 | 720 | * |
| 721 | | - * @return \type{\string} |
| | 721 | + * @return \type{\string} New random password |
| 722 | 722 | */ |
| 723 | 723 | static function randomPassword() { |
| 724 | 724 | global $wgMinimalPasswordLength; |
| — | — | @@ -979,7 +979,7 @@ |
| 980 | 980 | * Get a given default option value. |
| 981 | 981 | * |
| 982 | 982 | * @param $opt \type{\string} Name of option to retrieve |
| 983 | | - * @return \type{\string} |
| | 983 | + * @return \type{\string} Default option value |
| 984 | 984 | */ |
| 985 | 985 | public static function getDefaultOption( $opt ) { |
| 986 | 986 | $defOpts = self::getDefaultOptions(); |
| — | — | @@ -992,7 +992,7 @@ |
| 993 | 993 | |
| 994 | 994 | /** |
| 995 | 995 | * Get a list of user toggle names |
| 996 | | - * @return \arrayof{\string} |
| | 996 | + * @return \arrayof{\string} Array of user toggle names |
| 997 | 997 | */ |
| 998 | 998 | static function getToggles() { |
| 999 | 999 | global $wgContLang; |
| — | — | @@ -1080,7 +1080,7 @@ |
| 1081 | 1081 | * Whether the given IP is in the SORBS blacklist. |
| 1082 | 1082 | * |
| 1083 | 1083 | * @param $ip \type{\string} IP to check |
| 1084 | | - * @return \type{\bool} |
| | 1084 | + * @return \type{\bool} True if blacklisted |
| 1085 | 1085 | */ |
| 1086 | 1086 | function inSorbsBlacklist( $ip ) { |
| 1087 | 1087 | global $wgEnableSorbs, $wgSorbsUrl; |
| — | — | @@ -1094,7 +1094,7 @@ |
| 1095 | 1095 | * |
| 1096 | 1096 | * @param $ip \type{\string} IP to check |
| 1097 | 1097 | * @param $base \type{\string} URL of the DNS blacklist |
| 1098 | | - * @return \type{\bool} |
| | 1098 | + * @return \type{\bool} True if blacklisted |
| 1099 | 1099 | */ |
| 1100 | 1100 | function inDnsBlacklist( $ip, $base ) { |
| 1101 | 1101 | wfProfileIn( __METHOD__ ); |
| — | — | @@ -1128,7 +1128,7 @@ |
| 1129 | 1129 | /** |
| 1130 | 1130 | * Is this user subject to rate limiting? |
| 1131 | 1131 | * |
| 1132 | | - * @return \type{\bool} |
| | 1132 | + * @return \type{\bool} True if rate limited |
| 1133 | 1133 | */ |
| 1134 | 1134 | public function isPingLimitable() { |
| 1135 | 1135 | global $wgRateLimitsExcludedGroups; |
| — | — | @@ -1317,7 +1317,7 @@ |
| 1318 | 1318 | |
| 1319 | 1319 | /** |
| 1320 | 1320 | * Get the user name, or the IP of an anonymous user |
| 1321 | | - * @return \type{\string} |
| | 1321 | + * @return \type{\string} User's name or IP address |
| 1322 | 1322 | */ |
| 1323 | 1323 | function getName() { |
| 1324 | 1324 | if ( !$this->mDataLoaded && $this->mFrom == 'name' ) { |
| — | — | @@ -1353,7 +1353,7 @@ |
| 1354 | 1354 | |
| 1355 | 1355 | /** |
| 1356 | 1356 | * Get the user's name escaped by underscores. |
| 1357 | | - * @return \type{\string} |
| | 1357 | + * @return \type{\string} Username escaped by underscores |
| 1358 | 1358 | */ |
| 1359 | 1359 | function getTitleKey() { |
| 1360 | 1360 | return str_replace( ' ', '_', $this->getName() ); |
| — | — | @@ -1623,7 +1623,7 @@ |
| 1624 | 1624 | |
| 1625 | 1625 | /** |
| 1626 | 1626 | * Get the user's current token. |
| 1627 | | - * @return \type{\string} |
| | 1627 | + * @return \type{\string} Token |
| 1628 | 1628 | */ |
| 1629 | 1629 | function getToken() { |
| 1630 | 1630 | $this->load(); |
| — | — | @@ -1682,7 +1682,7 @@ |
| 1683 | 1683 | /** |
| 1684 | 1684 | * Has password reminder email been sent within the last |
| 1685 | 1685 | * $wgPasswordReminderResendTime hours? |
| 1686 | | - * @return \type{\bool} |
| | 1686 | + * @return \type{\bool} True or false |
| 1687 | 1687 | */ |
| 1688 | 1688 | function isPasswordReminderThrottled() { |
| 1689 | 1689 | global $wgPasswordReminderResendTime; |
| — | — | @@ -1696,7 +1696,7 @@ |
| 1697 | 1697 | |
| 1698 | 1698 | /** |
| 1699 | 1699 | * Get the user's e-mail address |
| 1700 | | - * @return \type{\string} |
| | 1700 | + * @return \type{\string} User's e-mail address |
| 1701 | 1701 | */ |
| 1702 | 1702 | function getEmail() { |
| 1703 | 1703 | $this->load(); |
| — | — | @@ -1726,7 +1726,7 @@ |
| 1727 | 1727 | |
| 1728 | 1728 | /** |
| 1729 | 1729 | * Get the user's real name |
| 1730 | | - * @return \type{\string} |
| | 1730 | + * @return \type{\string} User's real name |
| 1731 | 1731 | */ |
| 1732 | 1732 | function getRealName() { |
| 1733 | 1733 | $this->load(); |
| — | — | @@ -1828,7 +1828,7 @@ |
| 1829 | 1829 | |
| 1830 | 1830 | /** |
| 1831 | 1831 | * Get the user's preferred date format. |
| 1832 | | - * @return \type{\string} |
| | 1832 | + * @return \type{\string} User's preferred date format |
| 1833 | 1833 | */ |
| 1834 | 1834 | function getDatePreference() { |
| 1835 | 1835 | // Important migration for old data rows |
| — | — | @@ -1846,7 +1846,7 @@ |
| 1847 | 1847 | |
| 1848 | 1848 | /** |
| 1849 | 1849 | * Get the permissions this user has. |
| 1850 | | - * @return \arrayof{\string} |
| | 1850 | + * @return \arrayof{\string} Array of permission names |
| 1851 | 1851 | */ |
| 1852 | 1852 | function getRights() { |
| 1853 | 1853 | if ( is_null( $this->mRights ) ) { |
| — | — | @@ -1861,7 +1861,7 @@ |
| 1862 | 1862 | /** |
| 1863 | 1863 | * Get the list of explicit group memberships this user has. |
| 1864 | 1864 | * The implicit * and user groups are not included. |
| 1865 | | - * @return \arrayof{\string} |
| | 1865 | + * @return \arrayof{\string} Array of internal group names |
| 1866 | 1866 | */ |
| 1867 | 1867 | function getGroups() { |
| 1868 | 1868 | $this->load(); |
| — | — | @@ -1872,8 +1872,9 @@ |
| 1873 | 1873 | * Get the list of implicit group memberships this user has. |
| 1874 | 1874 | * This includes all explicit groups, plus 'user' if logged in, |
| 1875 | 1875 | * '*' for all accounts and autopromoted groups |
| | 1876 | + * |
| 1876 | 1877 | * @param $recache \type{\bool} Whether to avoid the cache |
| 1877 | | - * @return \arrayof{\string} |
| | 1878 | + * @return \arrayof{\string} Array of internal group names |
| 1878 | 1879 | */ |
| 1879 | 1880 | function getEffectiveGroups( $recache = false ) { |
| 1880 | 1881 | if ( $recache || is_null( $this->mEffectiveGroups ) ) { |
| — | — | @@ -1896,7 +1897,7 @@ |
| 1897 | 1898 | |
| 1898 | 1899 | /** |
| 1899 | 1900 | * Get the user's edit count. |
| 1900 | | - * @return \type{\int} |
| | 1901 | + * @return \type{\int} User's edit count |
| 1901 | 1902 | */ |
| 1902 | 1903 | function getEditCount() { |
| 1903 | 1904 | if ($this->mId) { |
| — | — | @@ -1960,7 +1961,7 @@ |
| 1961 | 1962 | |
| 1962 | 1963 | /** |
| 1963 | 1964 | * Get whether the user is logged in |
| 1964 | | - * @return \type{\bool} |
| | 1965 | + * @return \type{\bool} True or false |
| 1965 | 1966 | */ |
| 1966 | 1967 | function isLoggedIn() { |
| 1967 | 1968 | return $this->getID() != 0; |
| — | — | @@ -1968,7 +1969,7 @@ |
| 1969 | 1970 | |
| 1970 | 1971 | /** |
| 1971 | 1972 | * Get whether the user is anonymous |
| 1972 | | - * @return \type{\bool} |
| | 1973 | + * @return \type{\bool} True or false |
| 1973 | 1974 | */ |
| 1974 | 1975 | function isAnon() { |
| 1975 | 1976 | return !$this->isLoggedIn(); |
| — | — | @@ -1976,7 +1977,7 @@ |
| 1977 | 1978 | |
| 1978 | 1979 | /** |
| 1979 | 1980 | * Get whether the user is a bot |
| 1980 | | - * @return \type{\bool} |
| | 1981 | + * @return \type{\bool} True or false |
| 1981 | 1982 | * @deprecated |
| 1982 | 1983 | */ |
| 1983 | 1984 | function isBot() { |
| — | — | @@ -1999,7 +2000,7 @@ |
| 2000 | 2001 | |
| 2001 | 2002 | /** |
| 2002 | 2003 | * Check whether to enable recent changes patrol features for this user |
| 2003 | | - * @return \type{\bool} |
| | 2004 | + * @return \type{\bool} True or false |
| 2004 | 2005 | */ |
| 2005 | 2006 | public function useRCPatrol() { |
| 2006 | 2007 | global $wgUseRCPatrol; |
| — | — | @@ -2008,7 +2009,7 @@ |
| 2009 | 2010 | |
| 2010 | 2011 | /** |
| 2011 | 2012 | * Check whether to enable new pages patrol features for this user |
| 2012 | | - * @return \type{\bool} |
| | 2013 | + * @return \type{\bool} True or false |
| 2013 | 2014 | */ |
| 2014 | 2015 | public function useNPPatrol() { |
| 2015 | 2016 | global $wgUseRCPatrol, $wgUseNPPatrol; |
| — | — | @@ -2017,7 +2018,7 @@ |
| 2018 | 2019 | |
| 2019 | 2020 | /** |
| 2020 | 2021 | * Get the current skin, loading it if required |
| 2021 | | - * @return \type{Skin} |
| | 2022 | + * @return \type{Skin} Current skin |
| 2022 | 2023 | * @todo FIXME : need to check the old failback system [AV] |
| 2023 | 2024 | */ |
| 2024 | 2025 | function &getSkin() { |
| — | — | @@ -2456,7 +2457,7 @@ |
| 2457 | 2458 | * which will give them a chance to modify this key based on their own |
| 2458 | 2459 | * settings. |
| 2459 | 2460 | * |
| 2460 | | - * @return \type{\string} |
| | 2461 | + * @return \type{\string} Page rendering hash |
| 2461 | 2462 | */ |
| 2462 | 2463 | function getPageRenderingHash() { |
| 2463 | 2464 | global $wgContLang, $wgUseDynamicDates, $wgLang; |
| — | — | @@ -2491,7 +2492,7 @@ |
| 2492 | 2493 | |
| 2493 | 2494 | /** |
| 2494 | 2495 | * Get whether the user is explicitly blocked from account creation. |
| 2495 | | - * @return \type{\bool} |
| | 2496 | + * @return \type{\bool} True if blocked |
| 2496 | 2497 | */ |
| 2497 | 2498 | function isBlockedFromCreateAccount() { |
| 2498 | 2499 | $this->getBlockedStatus(); |
| — | — | @@ -2500,7 +2501,7 @@ |
| 2501 | 2502 | |
| 2502 | 2503 | /** |
| 2503 | 2504 | * Get whether the user is blocked from using Special:Emailuser. |
| 2504 | | - * @return \type{\bool} |
| | 2505 | + * @return \type{\bool} True if blocked |
| 2505 | 2506 | */ |
| 2506 | 2507 | function isBlockedFromEmailuser() { |
| 2507 | 2508 | $this->getBlockedStatus(); |
| — | — | @@ -2509,7 +2510,7 @@ |
| 2510 | 2511 | |
| 2511 | 2512 | /** |
| 2512 | 2513 | * Get whether the user is allowed to create an account. |
| 2513 | | - * @return \type{\bool} |
| | 2514 | + * @return \type{\bool} True if allowed |
| 2514 | 2515 | */ |
| 2515 | 2516 | function isAllowedToCreateAccount() { |
| 2516 | 2517 | return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount(); |
| — | — | @@ -2525,7 +2526,7 @@ |
| 2526 | 2527 | /** |
| 2527 | 2528 | * Get this user's personal page title. |
| 2528 | 2529 | * |
| 2529 | | - * @return \type{Title} |
| | 2530 | + * @return \type{Title} User's personal page title |
| 2530 | 2531 | */ |
| 2531 | 2532 | function getUserPage() { |
| 2532 | 2533 | return Title::makeTitle( NS_USER, $this->getName() ); |
| — | — | @@ -2534,7 +2535,7 @@ |
| 2535 | 2536 | /** |
| 2536 | 2537 | * Get this user's talk page title. |
| 2537 | 2538 | * |
| 2538 | | - * @return \type{Title} |
| | 2539 | + * @return \type{Title} User's talk page title |
| 2539 | 2540 | */ |
| 2540 | 2541 | function getTalkPage() { |
| 2541 | 2542 | $title = $this->getUserPage(); |
| — | — | @@ -2543,7 +2544,7 @@ |
| 2544 | 2545 | |
| 2545 | 2546 | /** |
| 2546 | 2547 | * Get the maximum valid user ID. |
| 2547 | | - * @return \type{\int} |
| | 2548 | + * @return \type{\int} %User ID |
| 2548 | 2549 | * @static |
| 2549 | 2550 | */ |
| 2550 | 2551 | function getMaxID() { |
| — | — | @@ -2635,7 +2636,7 @@ |
| 2636 | 2637 | /** |
| 2637 | 2638 | * Check if the given clear-text password matches the temporary password |
| 2638 | 2639 | * sent by e-mail for password reset operations. |
| 2639 | | - * @return \type{\bool} |
| | 2640 | + * @return \type{\bool} True if matches, false otherwise |
| 2640 | 2641 | */ |
| 2641 | 2642 | function checkTemporaryPassword( $plaintext ) { |
| 2642 | 2643 | return self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ); |
| — | — | @@ -2739,7 +2740,7 @@ |
| 2740 | 2741 | * @param $subject \type{\string} Message subject |
| 2741 | 2742 | * @param $body \type{\string} Message body |
| 2742 | 2743 | * @param $from \type{\string} Optional From address; if unspecified, default $wgPasswordSender will be used |
| 2743 | | - * @param $replyto \type{\string} |
| | 2744 | + * @param $replyto \type{\string} Reply-to address |
| 2744 | 2745 | * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure |
| 2745 | 2746 | */ |
| 2746 | 2747 | function sendMail( $subject, $body, $from = null, $replyto = null ) { |
| — | — | @@ -2761,7 +2762,7 @@ |
| 2762 | 2763 | * this change to the database. |
| 2763 | 2764 | * |
| 2764 | 2765 | * @param[out] &$expiration \type{\mixed} Accepts the expiration time |
| 2765 | | - * @return \type{\string} |
| | 2766 | + * @return \type{\string} New token |
| 2766 | 2767 | * @private |
| 2767 | 2768 | */ |
| 2768 | 2769 | function confirmationToken( &$expiration ) { |
| — | — | @@ -2779,7 +2780,7 @@ |
| 2780 | 2781 | /** |
| 2781 | 2782 | * Return a URL the user can use to confirm their email address. |
| 2782 | 2783 | * @param $token \type{\string} Accepts the email confirmation token |
| 2783 | | - * @return \type{\string} |
| | 2784 | + * @return \type{\string} New token URL |
| 2784 | 2785 | * @private |
| 2785 | 2786 | */ |
| 2786 | 2787 | function confirmationTokenUrl( $token ) { |
| — | — | @@ -2787,8 +2788,9 @@ |
| 2788 | 2789 | } |
| 2789 | 2790 | /** |
| 2790 | 2791 | * Return a URL the user can use to invalidate their email address. |
| | 2792 | + * |
| 2791 | 2793 | * @param $token \type{\string} Accepts the email confirmation token |
| 2792 | | - * @return \type{\string} |
| | 2794 | + * @return \type{\string} New token URL |
| 2793 | 2795 | * @private |
| 2794 | 2796 | */ |
| 2795 | 2797 | function invalidationTokenUrl( $token ) { |
| — | — | @@ -2855,7 +2857,7 @@ |
| 2856 | 2858 | /** |
| 2857 | 2859 | * Is this user allowed to send e-mails within limits of current |
| 2858 | 2860 | * site configuration? |
| 2859 | | - * @return \type{\bool} |
| | 2861 | + * @return \type{\bool} True if allowed |
| 2860 | 2862 | */ |
| 2861 | 2863 | function canSendEmail() { |
| 2862 | 2864 | $canSend = $this->isEmailConfirmed(); |
| — | — | @@ -2866,7 +2868,7 @@ |
| 2867 | 2869 | /** |
| 2868 | 2870 | * Is this user allowed to receive e-mails within limits of current |
| 2869 | 2871 | * site configuration? |
| 2870 | | - * @return \type{\bool} |
| | 2872 | + * @return \type{\bool} True if allowed |
| 2871 | 2873 | */ |
| 2872 | 2874 | function canReceiveEmail() { |
| 2873 | 2875 | return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' ); |
| — | — | @@ -2880,7 +2882,7 @@ |
| 2881 | 2883 | * confirmed their address by returning a code or using a password |
| 2882 | 2884 | * sent to the address from the wiki. |
| 2883 | 2885 | * |
| 2884 | | - * @return \type{\bool} |
| | 2886 | + * @return \type{\bool} True if confirmed |
| 2885 | 2887 | */ |
| 2886 | 2888 | function isEmailConfirmed() { |
| 2887 | 2889 | global $wgEmailAuthentication; |
| — | — | @@ -2901,7 +2903,7 @@ |
| 2902 | 2904 | |
| 2903 | 2905 | /** |
| 2904 | 2906 | * Check whether there is an outstanding request for e-mail confirmation. |
| 2905 | | - * @return \type{\bool} |
| | 2907 | + * @return \type{\bool} True if pending |
| 2906 | 2908 | */ |
| 2907 | 2909 | function isEmailConfirmationPending() { |
| 2908 | 2910 | global $wgEmailAuthentication; |
| — | — | @@ -2962,7 +2964,7 @@ |
| 2963 | 2965 | * Get the localized descriptive name for a group, if it exists |
| 2964 | 2966 | * |
| 2965 | 2967 | * @param $group \type{\string} Internal group name |
| 2966 | | - * @return \type{\string} |
| | 2968 | + * @return \type{\string} Localized descriptive group name |
| 2967 | 2969 | */ |
| 2968 | 2970 | static function getGroupName( $group ) { |
| 2969 | 2971 | global $wgMessageCache; |
| — | — | @@ -2978,7 +2980,7 @@ |
| 2979 | 2981 | * Get the localized descriptive name for a member of a group, if it exists |
| 2980 | 2982 | * |
| 2981 | 2983 | * @param $group \type{\string} Internal group name |
| 2982 | | - * @return \type{\string} |
| | 2984 | + * @return \type{\string} Localized name for group member |
| 2983 | 2985 | */ |
| 2984 | 2986 | static function getGroupMember( $group ) { |
| 2985 | 2987 | global $wgMessageCache; |
| — | — | @@ -2994,7 +2996,7 @@ |
| 2995 | 2997 | * Return the set of defined explicit groups. |
| 2996 | 2998 | * The implicit groups (by default *, 'user' and 'autoconfirmed') |
| 2997 | 2999 | * are not included, as they are defined automatically, not in the database. |
| 2998 | | - * @return \arrayof{\string} |
| | 3000 | + * @return \arrayof{\string} Array of internal group names |
| 2999 | 3001 | */ |
| 3000 | 3002 | static function getAllGroups() { |
| 3001 | 3003 | global $wgGroupPermissions; |
| — | — | @@ -3006,7 +3008,7 @@ |
| 3007 | 3009 | |
| 3008 | 3010 | /** |
| 3009 | 3011 | * Get a list of all available permissions. |
| 3010 | | - * @return \arrayof{\string} |
| | 3012 | + * @return \arrayof{\string} Array of permission names |
| 3011 | 3013 | */ |
| 3012 | 3014 | static function getAllRights() { |
| 3013 | 3015 | if ( self::$mAllRights === false ) { |
| — | — | @@ -3023,7 +3025,7 @@ |
| 3024 | 3026 | |
| 3025 | 3027 | /** |
| 3026 | 3028 | * Get a list of implicit groups |
| 3027 | | - * @return \arrayof{\string} |
| | 3029 | + * @return \arrayof{\string} Array of internal group names |
| 3028 | 3030 | */ |
| 3029 | 3031 | public static function getImplicitGroups() { |
| 3030 | 3032 | global $wgImplicitGroups; |
| — | — | @@ -3141,7 +3143,7 @@ |
| 3142 | 3144 | * Get the description of a given right |
| 3143 | 3145 | * |
| 3144 | 3146 | * @param $right \type{\string} Right to query |
| 3145 | | - * @return \type{\string} |
| | 3147 | + * @return \type{\string} Localized description of the right |
| 3146 | 3148 | */ |
| 3147 | 3149 | static function getRightDescription( $right ) { |
| 3148 | 3150 | global $wgMessageCache; |
| — | — | @@ -3197,7 +3199,7 @@ |
| 3198 | 3200 | * @param $hash \type{\string} Password hash |
| 3199 | 3201 | * @param $password \type{\string} Plain-text password to compare |
| 3200 | 3202 | * @param $userId \type{\string} %User ID for old-style password salt |
| 3201 | | - * @return \type{\bool} |
| | 3203 | + * @return \type{\bool} True if matches, false otherwise |
| 3202 | 3204 | */ |
| 3203 | 3205 | static function comparePasswords( $hash, $password, $userId = false ) { |
| 3204 | 3206 | $m = false; |