From: Fran Rogers Date: Thu, 7 Aug 2008 10:43:36 +0000 (+0000) Subject: Non-crap version of r38753 - sorry about that ._. X-Git-Tag: 1.31.0-rc.0~46058 X-Git-Url: http://git.cyclocoop.org/%24image?a=commitdiff_plain;h=2bf24df984eb70074c1f86b732f64933b06965a8;p=lhc%2Fweb%2Fwiklou.git Non-crap version of r38753 - sorry about that ._. --- diff --git a/includes/User.php b/includes/User.php index 99b0dd6e46..97509d6db6 100644 --- a/includes/User.php +++ b/includes/User.php @@ -461,8 +461,8 @@ class User { * addresses like this, if we allowed accounts like this to be created * new users could get the old edits of these anonymous users. * - * @param $name \type{\string} - * @return \type{\bool} + * @param $name \type{\string} String to match + * @return \type{\bool} True or false */ static function isIP( $name ) { return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP::isIPv6($name); @@ -476,8 +476,8 @@ class User { * is longer than the maximum allowed username size or doesn't begin with * a capital letter. * - * @param $name \type{\string} - * @return \type{\bool} + * @param $name \type{\string} String to match + * @return \type{\bool} True or false */ static function isValidUserName( $name ) { global $wgContLang, $wgMaxNameChars; @@ -530,8 +530,8 @@ class User { * If an account already exists in this form, login will be blocked * by a failure to pass this function. * - * @param $name \type{\string} - * @return \type{\bool} + * @param $name \type{\string} String to match + * @return \type{\bool} True or false */ static function isUsableName( $name ) { global $wgReservedUsernames; @@ -568,8 +568,8 @@ class User { * rather than in isValidUserName() to avoid disrupting * existing accounts. * - * @param $name \type{\string} - * @return \type{\bool} + * @param $name \type{\string} String to match + * @return \type{\bool} True or false */ static function isCreatableName( $name ) { return @@ -583,7 +583,7 @@ class User { * Is the input a valid password for this user? * * @param $password \type{\string} Desired password - * @return \type{\bool} + * @return \type{\bool} True or false */ function isValidPassword( $password ) { global $wgMinimalPasswordLength, $wgContLang; @@ -609,7 +609,7 @@ class User { * @todo Check for RFC 2822 compilance (bug 959) * * @param $addr \type{\string} E-mail address - * @return \type{\bool} + * @return \type{\bool} True or false */ public static function isValidEmailAddr( $addr ) { $result = null; @@ -717,7 +717,7 @@ class User { * Return a random password. Sourced from mt_rand, so it's not particularly secure. * @todo hash random numbers to improve security, like generateToken() * - * @return \type{\string} + * @return \type{\string} New random password */ static function randomPassword() { global $wgMinimalPasswordLength; @@ -979,7 +979,7 @@ class User { * Get a given default option value. * * @param $opt \type{\string} Name of option to retrieve - * @return \type{\string} + * @return \type{\string} Default option value */ public static function getDefaultOption( $opt ) { $defOpts = self::getDefaultOptions(); @@ -992,7 +992,7 @@ class User { /** * Get a list of user toggle names - * @return \arrayof{\string} + * @return \arrayof{\string} Array of user toggle names */ static function getToggles() { global $wgContLang; @@ -1080,7 +1080,7 @@ class User { * Whether the given IP is in the SORBS blacklist. * * @param $ip \type{\string} IP to check - * @return \type{\bool} + * @return \type{\bool} True if blacklisted */ function inSorbsBlacklist( $ip ) { global $wgEnableSorbs, $wgSorbsUrl; @@ -1094,7 +1094,7 @@ class User { * * @param $ip \type{\string} IP to check * @param $base \type{\string} URL of the DNS blacklist - * @return \type{\bool} + * @return \type{\bool} True if blacklisted */ function inDnsBlacklist( $ip, $base ) { wfProfileIn( __METHOD__ ); @@ -1128,7 +1128,7 @@ class User { /** * Is this user subject to rate limiting? * - * @return \type{\bool} + * @return \type{\bool} True if rate limited */ public function isPingLimitable() { global $wgRateLimitsExcludedGroups; @@ -1317,7 +1317,7 @@ class User { /** * Get the user name, or the IP of an anonymous user - * @return \type{\string} + * @return \type{\string} User's name or IP address */ function getName() { if ( !$this->mDataLoaded && $this->mFrom == 'name' ) { @@ -1353,7 +1353,7 @@ class User { /** * Get the user's name escaped by underscores. - * @return \type{\string} + * @return \type{\string} Username escaped by underscores */ function getTitleKey() { return str_replace( ' ', '_', $this->getName() ); @@ -1623,7 +1623,7 @@ class User { /** * Get the user's current token. - * @return \type{\string} + * @return \type{\string} Token */ function getToken() { $this->load(); @@ -1682,7 +1682,7 @@ class User { /** * Has password reminder email been sent within the last * $wgPasswordReminderResendTime hours? - * @return \type{\bool} + * @return \type{\bool} True or false */ function isPasswordReminderThrottled() { global $wgPasswordReminderResendTime; @@ -1696,7 +1696,7 @@ class User { /** * Get the user's e-mail address - * @return \type{\string} + * @return \type{\string} User's e-mail address */ function getEmail() { $this->load(); @@ -1726,7 +1726,7 @@ class User { /** * Get the user's real name - * @return \type{\string} + * @return \type{\string} User's real name */ function getRealName() { $this->load(); @@ -1828,7 +1828,7 @@ class User { /** * Get the user's preferred date format. - * @return \type{\string} + * @return \type{\string} User's preferred date format */ function getDatePreference() { // Important migration for old data rows @@ -1846,7 +1846,7 @@ class User { /** * Get the permissions this user has. - * @return \arrayof{\string} + * @return \arrayof{\string} Array of permission names */ function getRights() { if ( is_null( $this->mRights ) ) { @@ -1861,7 +1861,7 @@ class User { /** * Get the list of explicit group memberships this user has. * The implicit * and user groups are not included. - * @return \arrayof{\string} + * @return \arrayof{\string} Array of internal group names */ function getGroups() { $this->load(); @@ -1872,8 +1872,9 @@ class User { * Get the list of implicit group memberships this user has. * This includes all explicit groups, plus 'user' if logged in, * '*' for all accounts and autopromoted groups + * * @param $recache \type{\bool} Whether to avoid the cache - * @return \arrayof{\string} + * @return \arrayof{\string} Array of internal group names */ function getEffectiveGroups( $recache = false ) { if ( $recache || is_null( $this->mEffectiveGroups ) ) { @@ -1896,7 +1897,7 @@ class User { /** * Get the user's edit count. - * @return \type{\int} + * @return \type{\int} User's edit count */ function getEditCount() { if ($this->mId) { @@ -1960,7 +1961,7 @@ class User { /** * Get whether the user is logged in - * @return \type{\bool} + * @return \type{\bool} True or false */ function isLoggedIn() { return $this->getID() != 0; @@ -1968,7 +1969,7 @@ class User { /** * Get whether the user is anonymous - * @return \type{\bool} + * @return \type{\bool} True or false */ function isAnon() { return !$this->isLoggedIn(); @@ -1976,7 +1977,7 @@ class User { /** * Get whether the user is a bot - * @return \type{\bool} + * @return \type{\bool} True or false * @deprecated */ function isBot() { @@ -1999,7 +2000,7 @@ class User { /** * Check whether to enable recent changes patrol features for this user - * @return \type{\bool} + * @return \type{\bool} True or false */ public function useRCPatrol() { global $wgUseRCPatrol; @@ -2008,7 +2009,7 @@ class User { /** * Check whether to enable new pages patrol features for this user - * @return \type{\bool} + * @return \type{\bool} True or false */ public function useNPPatrol() { global $wgUseRCPatrol, $wgUseNPPatrol; @@ -2017,7 +2018,7 @@ class User { /** * Get the current skin, loading it if required - * @return \type{Skin} + * @return \type{Skin} Current skin * @todo FIXME : need to check the old failback system [AV] */ function &getSkin() { @@ -2456,7 +2457,7 @@ class User { * which will give them a chance to modify this key based on their own * settings. * - * @return \type{\string} + * @return \type{\string} Page rendering hash */ function getPageRenderingHash() { global $wgContLang, $wgUseDynamicDates, $wgLang; @@ -2491,7 +2492,7 @@ class User { /** * Get whether the user is explicitly blocked from account creation. - * @return \type{\bool} + * @return \type{\bool} True if blocked */ function isBlockedFromCreateAccount() { $this->getBlockedStatus(); @@ -2500,7 +2501,7 @@ class User { /** * Get whether the user is blocked from using Special:Emailuser. - * @return \type{\bool} + * @return \type{\bool} True if blocked */ function isBlockedFromEmailuser() { $this->getBlockedStatus(); @@ -2509,7 +2510,7 @@ class User { /** * Get whether the user is allowed to create an account. - * @return \type{\bool} + * @return \type{\bool} True if allowed */ function isAllowedToCreateAccount() { return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount(); @@ -2525,7 +2526,7 @@ class User { /** * Get this user's personal page title. * - * @return \type{Title} + * @return \type{Title} User's personal page title */ function getUserPage() { return Title::makeTitle( NS_USER, $this->getName() ); @@ -2534,7 +2535,7 @@ class User { /** * Get this user's talk page title. * - * @return \type{Title} + * @return \type{Title} User's talk page title */ function getTalkPage() { $title = $this->getUserPage(); @@ -2543,7 +2544,7 @@ class User { /** * Get the maximum valid user ID. - * @return \type{\int} + * @return \type{\int} %User ID * @static */ function getMaxID() { @@ -2635,7 +2636,7 @@ class User { /** * Check if the given clear-text password matches the temporary password * sent by e-mail for password reset operations. - * @return \type{\bool} + * @return \type{\bool} True if matches, false otherwise */ function checkTemporaryPassword( $plaintext ) { return self::comparePasswords( $this->mNewpassword, $plaintext, $this->getId() ); @@ -2739,7 +2740,7 @@ class User { * @param $subject \type{\string} Message subject * @param $body \type{\string} Message body * @param $from \type{\string} Optional From address; if unspecified, default $wgPasswordSender will be used - * @param $replyto \type{\string} + * @param $replyto \type{\string} Reply-to address * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure */ function sendMail( $subject, $body, $from = null, $replyto = null ) { @@ -2761,7 +2762,7 @@ class User { * this change to the database. * * @param[out] &$expiration \type{\mixed} Accepts the expiration time - * @return \type{\string} + * @return \type{\string} New token * @private */ function confirmationToken( &$expiration ) { @@ -2779,7 +2780,7 @@ class User { /** * Return a URL the user can use to confirm their email address. * @param $token \type{\string} Accepts the email confirmation token - * @return \type{\string} + * @return \type{\string} New token URL * @private */ function confirmationTokenUrl( $token ) { @@ -2787,8 +2788,9 @@ class User { } /** * Return a URL the user can use to invalidate their email address. + * * @param $token \type{\string} Accepts the email confirmation token - * @return \type{\string} + * @return \type{\string} New token URL * @private */ function invalidationTokenUrl( $token ) { @@ -2855,7 +2857,7 @@ class User { /** * Is this user allowed to send e-mails within limits of current * site configuration? - * @return \type{\bool} + * @return \type{\bool} True if allowed */ function canSendEmail() { $canSend = $this->isEmailConfirmed(); @@ -2866,7 +2868,7 @@ class User { /** * Is this user allowed to receive e-mails within limits of current * site configuration? - * @return \type{\bool} + * @return \type{\bool} True if allowed */ function canReceiveEmail() { return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' ); @@ -2880,7 +2882,7 @@ class User { * confirmed their address by returning a code or using a password * sent to the address from the wiki. * - * @return \type{\bool} + * @return \type{\bool} True if confirmed */ function isEmailConfirmed() { global $wgEmailAuthentication; @@ -2901,7 +2903,7 @@ class User { /** * Check whether there is an outstanding request for e-mail confirmation. - * @return \type{\bool} + * @return \type{\bool} True if pending */ function isEmailConfirmationPending() { global $wgEmailAuthentication; @@ -2962,7 +2964,7 @@ class User { * Get the localized descriptive name for a group, if it exists * * @param $group \type{\string} Internal group name - * @return \type{\string} + * @return \type{\string} Localized descriptive group name */ static function getGroupName( $group ) { global $wgMessageCache; @@ -2978,7 +2980,7 @@ class User { * Get the localized descriptive name for a member of a group, if it exists * * @param $group \type{\string} Internal group name - * @return \type{\string} + * @return \type{\string} Localized name for group member */ static function getGroupMember( $group ) { global $wgMessageCache; @@ -2994,7 +2996,7 @@ class User { * Return the set of defined explicit groups. * The implicit groups (by default *, 'user' and 'autoconfirmed') * are not included, as they are defined automatically, not in the database. - * @return \arrayof{\string} + * @return \arrayof{\string} Array of internal group names */ static function getAllGroups() { global $wgGroupPermissions; @@ -3006,7 +3008,7 @@ class User { /** * Get a list of all available permissions. - * @return \arrayof{\string} + * @return \arrayof{\string} Array of permission names */ static function getAllRights() { if ( self::$mAllRights === false ) { @@ -3023,7 +3025,7 @@ class User { /** * Get a list of implicit groups - * @return \arrayof{\string} + * @return \arrayof{\string} Array of internal group names */ public static function getImplicitGroups() { global $wgImplicitGroups; @@ -3141,7 +3143,7 @@ class User { * Get the description of a given right * * @param $right \type{\string} Right to query - * @return \type{\string} + * @return \type{\string} Localized description of the right */ static function getRightDescription( $right ) { global $wgMessageCache; @@ -3197,7 +3199,7 @@ class User { * @param $hash \type{\string} Password hash * @param $password \type{\string} Plain-text password to compare * @param $userId \type{\string} %User ID for old-style password salt - * @return \type{\bool} + * @return \type{\bool} True if matches, false otherwise */ static function comparePasswords( $hash, $password, $userId = false ) { $m = false; diff --git a/maintenance/Doxyfile b/maintenance/Doxyfile index 6931f4aa58..e1df2bee8d 100644 --- a/maintenance/Doxyfile +++ b/maintenance/Doxyfile @@ -16,7 +16,7 @@ PROJECT_NAME = MediaWiki PROJECT_NUMBER = {{CURRENT_VERSION}} OUTPUT_DIRECTORY = {{OUTPUT_DIRECTORY}} -CREATE_SUBDIRS = NO +CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES @@ -175,7 +175,7 @@ CHM_FILE = HHC_LOCATION = GENERATE_CHI = NO BINARY_TOC = NO -TOC_EXPAND = NO +TOC_EXPAND = YES DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = YES @@ -191,8 +191,8 @@ COMPACT_LATEX = NO PAPER_TYPE = a4wide EXTRA_PACKAGES = LATEX_HEADER = -PDF_HYPERLINKS = NO -USE_PDFLATEX = NO +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- @@ -207,7 +207,7 @@ RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -GENERATE_MAN = YES +GENERATE_MAN = NO MAN_OUTPUT = man MAN_EXTENSION = .3 MAN_LINKS = NO