http://www.mediawiki.org/wiki/Special:Code/MediaWiki/88397
Revision: 88397
Author: reedy
Date: 2011-05-19 00:03:31 +0000 (Thu, 19 May 2011)
Log Message:
-----------
Add/remove/tweak method documentation
Modified Paths:
--------------
trunk/phase3/includes/AuthPlugin.php
trunk/phase3/includes/Categoryfinder.php
trunk/phase3/includes/GlobalFunctions.php
trunk/phase3/includes/LogPage.php
trunk/phase3/includes/Sanitizer.php
trunk/phase3/includes/User.php
trunk/phase3/includes/db/LoadBalancer.php
trunk/phase3/includes/db/LoadMonitor.php
trunk/phase3/includes/media/Generic.php
Modified: trunk/phase3/includes/AuthPlugin.php
===================================================================
--- trunk/phase3/includes/AuthPlugin.php 2011-05-18 22:28:32 UTC (rev
88396)
+++ trunk/phase3/includes/AuthPlugin.php 2011-05-19 00:03:31 UTC (rev
88397)
@@ -131,6 +131,8 @@
* and use the same keys. 'Realname' 'Emailaddress' and 'Nickname'
* all reference this.
*
+ * @param $prop string
+ *
* @return Boolean
*/
public function allowPropChange( $prop = '' ) {
@@ -254,6 +256,8 @@
* Get an instance of a User object
*
* @param $user User
+ *
+ * @return AuthPluginUser
*/
public function getUserInstance( User &$user ) {
return new AuthPluginUser( $user );
Modified: trunk/phase3/includes/Categoryfinder.php
===================================================================
--- trunk/phase3/includes/Categoryfinder.php 2011-05-18 22:28:32 UTC (rev
88396)
+++ trunk/phase3/includes/Categoryfinder.php 2011-05-19 00:03:31 UTC (rev
88397)
@@ -86,9 +86,9 @@
/**
* This functions recurses through the parent representation, trying to
match the conditions
- * @param $id The article/category to check
- * @param $conds The array of categories to match
- * @param $path used to check for recursion loops
+ * @param $id int The article/category to check
+ * @param $conds array The array of categories to match
+ * @param $path array used to check for recursion loops
* @return bool Does this match the conditions?
*/
function check( $id, &$conds, $path = array() ) {
Modified: trunk/phase3/includes/GlobalFunctions.php
===================================================================
--- trunk/phase3/includes/GlobalFunctions.php 2011-05-18 22:28:32 UTC (rev
88396)
+++ trunk/phase3/includes/GlobalFunctions.php 2011-05-19 00:03:31 UTC (rev
88397)
@@ -3305,7 +3305,7 @@
* Generate a random 32-character hexadecimal token.
* @param $salt Mixed: some sort of salt, if necessary, to add to random
* characters before hashing.
- * @return Array
+ * @return string
* @codeCoverageIgnore
*/
function wfGenerateToken( $salt = '' ) {
Modified: trunk/phase3/includes/LogPage.php
===================================================================
--- trunk/phase3/includes/LogPage.php 2011-05-18 22:28:32 UTC (rev 88396)
+++ trunk/phase3/includes/LogPage.php 2011-05-19 00:03:31 UTC (rev 88397)
@@ -514,7 +514,7 @@
/**
* Translate a block log flag if possible
*
- * @param $flag Flag to translate
+ * @param $flag int Flag to translate
* @param $forContent Whether to localize the message depending of the
user
* language
* @return String
Modified: trunk/phase3/includes/Sanitizer.php
===================================================================
--- trunk/phase3/includes/Sanitizer.php 2011-05-18 22:28:32 UTC (rev 88396)
+++ trunk/phase3/includes/Sanitizer.php 2011-05-19 00:03:31 UTC (rev 88397)
@@ -1282,7 +1282,7 @@
* return the UTF-8 encoding of that character. Otherwise, returns
* pseudo-entity source (eg &foo;)
*
- * @param $name Strings
+ * @param $name String
* @return String
*/
static function decodeEntity( $name ) {
Modified: trunk/phase3/includes/User.php
===================================================================
--- trunk/phase3/includes/User.php 2011-05-18 22:28:32 UTC (rev 88396)
+++ trunk/phase3/includes/User.php 2011-05-19 00:03:31 UTC (rev 88397)
@@ -3693,6 +3693,8 @@
*
* @param $byEmail Boolean: account made by email?
* @param $reason String: user supplied reason
+ *
+ * @return true
*/
public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
global $wgUser, $wgContLang, $wgNewUserLog;
@@ -3726,6 +3728,8 @@
/**
* Add an autocreate newuser log entry for this user
* Used by things like CentralAuth and perhaps other authplugins.
+ *
+ * @return true
*/
public function addNewUserLogEntryAutoCreate() {
global $wgNewUserLog;
Modified: trunk/phase3/includes/db/LoadBalancer.php
===================================================================
--- trunk/phase3/includes/db/LoadBalancer.php 2011-05-18 22:28:32 UTC (rev
88396)
+++ trunk/phase3/includes/db/LoadBalancer.php 2011-05-19 00:03:31 UTC (rev
88397)
@@ -27,8 +27,7 @@
* masterWaitTimeout Replication lag wait timeout
* loadMonitor Name of a class used to fetch server lag and
load.
*/
- function __construct( $params )
- {
+ function __construct( $params ) {
if ( !isset( $params['servers'] ) ) {
throw new MWException( __CLASS__.': missing servers
parameter' );
}
Modified: trunk/phase3/includes/db/LoadMonitor.php
===================================================================
--- trunk/phase3/includes/db/LoadMonitor.php 2011-05-18 22:28:32 UTC (rev
88396)
+++ trunk/phase3/includes/db/LoadMonitor.php 2011-05-19 00:03:31 UTC (rev
88397)
@@ -21,7 +21,7 @@
/**
* Perform pre-connection load ratio adjustment.
- * @param $loads Array
+ * @param $loads array
* @param $group String: the selected query group
* @param $wiki String
*/
Modified: trunk/phase3/includes/media/Generic.php
===================================================================
--- trunk/phase3/includes/media/Generic.php 2011-05-18 22:28:32 UTC (rev
88396)
+++ trunk/phase3/includes/media/Generic.php 2011-05-19 00:03:31 UTC (rev
88397)
@@ -349,7 +349,7 @@
* @param &$array Array An array containing elements for each type of
visibility
* and each of those elements being an array of metadata items. This
function adds
* a value to that array.
- * @param $visibility String ('visible' or 'collapsed') if this value
is hidden
+ * @param $visibility string ('visible' or 'collapsed') if this value
is hidden
* by default.
* @param $type String type of metadata tag (currently always 'exif')
* @param $id String the name of the metadata tag (like 'artist' for
example).
@@ -362,8 +362,6 @@
* @param $param String value to pass to the message for the name of
the field
* as $1. Currently this parameter doesn't seem to ever be used.
*
- * @return Array $array but with the new metadata field added.
- *
* Note, everything here is passed through the parser later on (!)
*/
protected static function addMeta( &$array, $visibility, $type, $id,
$value, $param = false ) {
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
