http://www.mediawiki.org/wiki/Special:Code/MediaWiki/89037
Revision: 89037
Author: reedy
Date: 2011-05-28 14:52:55 +0000 (Sat, 28 May 2011)
Log Message:
-----------
More parameter documentation!!
Modified Paths:
--------------
trunk/phase3/includes/EditPage.php
trunk/phase3/includes/Linker.php
trunk/phase3/includes/User.php
trunk/phase3/includes/db/Database.php
trunk/phase3/includes/db/DatabasePostgres.php
trunk/phase3/includes/filerepo/OldLocalFile.php
trunk/phase3/includes/installer/Installer.php
trunk/phase3/includes/installer/WebInstaller.php
trunk/phase3/includes/installer/WebInstallerPage.php
trunk/phase3/includes/specials/SpecialUndelete.php
Modified: trunk/phase3/includes/EditPage.php
===================================================================
--- trunk/phase3/includes/EditPage.php 2011-05-28 14:51:07 UTC (rev 89036)
+++ trunk/phase3/includes/EditPage.php 2011-05-28 14:52:55 UTC (rev 89037)
@@ -1111,7 +1111,7 @@
$hasmatch = preg_match( "/^
*([=]{1,6})(.*?)(\\1) *\\n/i", $this->textbox1, $matches );
# we can't deal with anchors, includes, html
etc in the header for now,
# headline would need to be parsed to improve
this
- if ( $hasmatch and strlen( $matches[2] ) > 0 ) {
+ if ( $hasmatch && strlen( $matches[2] ) > 0 ) {
$sectionanchor =
$wgParser->guessLegacySectionNameFromWikiText( $matches[2] );
}
}
Modified: trunk/phase3/includes/Linker.php
===================================================================
--- trunk/phase3/includes/Linker.php 2011-05-28 14:51:07 UTC (rev 89036)
+++ trunk/phase3/includes/Linker.php 2011-05-28 14:52:55 UTC (rev 89037)
@@ -1067,6 +1067,9 @@
return $comment;
}
+ /**
+ * @var Title
+ */
static $autocommentTitle;
static $autocommentLocal;
Modified: trunk/phase3/includes/User.php
===================================================================
--- trunk/phase3/includes/User.php 2011-05-28 14:51:07 UTC (rev 89036)
+++ trunk/phase3/includes/User.php 2011-05-28 14:52:55 UTC (rev 89037)
@@ -1066,7 +1066,9 @@
}
/**
- * Load the data for this user object from another user object.
+ * Load the data for this user object from another user object.
+ *
+ * @param $user User
*/
protected function loadFromUserObject( $user ) {
$user->load();
Modified: trunk/phase3/includes/db/Database.php
===================================================================
--- trunk/phase3/includes/db/Database.php 2011-05-28 14:51:07 UTC (rev
89036)
+++ trunk/phase3/includes/db/Database.php 2011-05-28 14:52:55 UTC (rev
89037)
@@ -662,7 +662,7 @@
* comment (you can use __METHOD__ or add some extra info)
* @param $tempIgnore Boolean: Whether to avoid throwing an
exception on errors...
* maybe best to catch the exception instead?
- * @return boolean or ResultWrapper. true for a successful write query,
ResultWrapper object for a successful read query,
+ * @return boolean|ResultWrapper. true for a successful write query,
ResultWrapper object for a successful read query,
* or false on failure if $tempIgnore set
* @throws DBQueryError Thrown when the database returns an error of
any kind
*/
Modified: trunk/phase3/includes/db/DatabasePostgres.php
===================================================================
--- trunk/phase3/includes/db/DatabasePostgres.php 2011-05-28 14:51:07 UTC
(rev 89036)
+++ trunk/phase3/includes/db/DatabasePostgres.php 2011-05-28 14:52:55 UTC
(rev 89037)
@@ -929,6 +929,10 @@
return $sql;
}
+ /**
+ * @param $b
+ * @return Blob
+ */
function encodeBlob( $b ) {
return new Blob( pg_escape_bytea( $this->mConn, $b ) );
}
@@ -944,6 +948,10 @@
return pg_escape_string( $this->mConn, $s );
}
+ /**
+ * @param $s null|bool|Blob
+ * @return int|string
+ */
function addQuotes( $s ) {
if ( is_null( $s ) ) {
return 'NULL';
Modified: trunk/phase3/includes/filerepo/OldLocalFile.php
===================================================================
--- trunk/phase3/includes/filerepo/OldLocalFile.php 2011-05-28 14:51:07 UTC
(rev 89036)
+++ trunk/phase3/includes/filerepo/OldLocalFile.php 2011-05-28 14:52:55 UTC
(rev 89037)
@@ -218,6 +218,8 @@
* @param $srcPath string File system path of the source file
* @param $archiveName string Full archive name of the file, in the
form
* $timestamp!$filename, where $filename must match
$this->getName()
+ *
+ * @return FileRepoStatus
*/
function uploadOld( $srcPath, $archiveName, $timestamp, $comment,
$user, $flags = 0 ) {
$this->lock();
Modified: trunk/phase3/includes/installer/Installer.php
===================================================================
--- trunk/phase3/includes/installer/Installer.php 2011-05-28 14:51:07 UTC
(rev 89036)
+++ trunk/phase3/includes/installer/Installer.php 2011-05-28 14:52:55 UTC
(rev 89037)
@@ -1173,6 +1173,8 @@
/**
* ParserOptions are constructed before we determined the language, so
fix it
+ *
+ * @param $lang Language
*/
public function setParserLanguage( $lang ) {
$this->parserOptions->setTargetLanguage( $lang );
Modified: trunk/phase3/includes/installer/WebInstaller.php
===================================================================
--- trunk/phase3/includes/installer/WebInstaller.php 2011-05-28 14:51:07 UTC
(rev 89036)
+++ trunk/phase3/includes/installer/WebInstaller.php 2011-05-28 14:52:55 UTC
(rev 89037)
@@ -953,6 +953,8 @@
/**
* Output an error or warning box using a Status object.
+ *
+ * @param $status Status
*/
public function showStatusBox( $status ) {
if( !$status->isGood() ) {
Modified: trunk/phase3/includes/installer/WebInstallerPage.php
===================================================================
--- trunk/phase3/includes/installer/WebInstallerPage.php 2011-05-28
14:51:07 UTC (rev 89036)
+++ trunk/phase3/includes/installer/WebInstallerPage.php 2011-05-28
14:52:55 UTC (rev 89037)
@@ -924,6 +924,9 @@
$this->endForm();
}
+ /**
+ * @return string
+ */
public function getCCPartnerUrl() {
global $wgServer;
$exitUrl = $wgServer . $this->parent->getUrl( array(
@@ -1112,6 +1115,10 @@
}
}
+ /**
+ * @param $step
+ * @param $status Status
+ */
public function endStage( $step, $status ) {
if ( $step == 'extension-tables' ) {
$this->endLiveBox();
Modified: trunk/phase3/includes/specials/SpecialUndelete.php
===================================================================
--- trunk/phase3/includes/specials/SpecialUndelete.php 2011-05-28 14:51:07 UTC
(rev 89036)
+++ trunk/phase3/includes/specials/SpecialUndelete.php 2011-05-28 14:52:55 UTC
(rev 89037)
@@ -570,9 +570,14 @@
* @ingroup SpecialPage
*/
class SpecialUndelete extends SpecialPage {
- var $mAction, $mTarget, $mTimestamp, $mRestore, $mInvert, $mTargetObj,
$mFile;
+ var $mAction, $mTarget, $mTimestamp, $mRestore, $mInvert, $mFile;
var $mTargetTimestamp, $mAllowed, $mCanView, $mComment, $mToken,
$mRequest;
+ /**
+ * @var Title
+ */
+ var $mTargetObj;
+
function __construct( $request = null ) {
parent::__construct( 'Undelete', 'deletedhistory' );
@@ -734,7 +739,12 @@
);
}
- // Generic list of deleted pages
+ /**
+ * Generic list of deleted pages
+ *
+ * @param $result ResultWrapper
+ * @return bool
+ */
private function showList( $result ) {
global $wgLang, $wgUser, $wgOut;
_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs
