Umherirrender has uploaded a new change for review. (
https://gerrit.wikimedia.org/r/399878 )
Change subject: Improve some parameter docs
......................................................................
Improve some parameter docs
Change-Id: I7ffe408d1c9108b087f54af259c65f9457c4b15d
---
M .phpcs.xml
M AdManager.class.php
M AdManager.hooks.php
M AdManagerZones.class.php
4 files changed, 12 insertions(+), 14 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/AdManager
refs/changes/78/399878/1
diff --git a/.phpcs.xml b/.phpcs.xml
index 752f0f3..6fea2c8 100644
--- a/.phpcs.xml
+++ b/.phpcs.xml
@@ -2,9 +2,6 @@
<ruleset>
<rule ref="./vendor/mediawiki/mediawiki-codesniffer/MediaWiki">
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamComment" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingParamTag" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.MissingReturn" />
- <exclude
name="MediaWiki.Commenting.FunctionComment.ParamNameNoMatch" />
<exclude name="MediaWiki.Files.ClassMatchesFilename.NotMatch" />
<exclude
name="MediaWiki.Commenting.FunctionComment.MissingDocumentationPublic" />
<exclude
name="MediaWiki.NamingConventions.LowerCamelFunctionsName.FunctionName" />
@@ -12,6 +9,5 @@
</rule>
<file>.</file>
<arg name="extensions" value="php,php5,inc" />
- <arg name="encoding" value="utf8" />
- <exclude-pattern>vendor</exclude-pattern>
+ <arg name="encoding" value="UTF-8" />
</ruleset>
diff --git a/AdManager.class.php b/AdManager.class.php
index 4297f0d..4782b76 100644
--- a/AdManager.class.php
+++ b/AdManager.class.php
@@ -344,14 +344,14 @@
}
/**
- * @return DatabaseBase Read-only db connection
+ * @return IDatabase Read-only db connection
*/
public static function getReadDbConnection() {
return wfGetDB( DB_REPLICA );
}
/**
- * @return DatabaseBase Writable db connection
+ * @return IDatabase Writable db connection
*/
public static function getWriteDbConnection() {
return wfGetDB( DB_MASTER );
diff --git a/AdManager.hooks.php b/AdManager.hooks.php
index 1544978..f18967a 100644
--- a/AdManager.hooks.php
+++ b/AdManager.hooks.php
@@ -3,6 +3,8 @@
/**
* Schema update to set up the needed database tables.
+ * @param DatabaseUpdater $updater
+ * @return true
*/
public static function onSchemaUpdate( DatabaseUpdater $updater ) {
$updater->addExtensionTable(
@@ -20,7 +22,7 @@
*
* @global string $wgAdManagerPlacement
* @param Skin $skin
- * @param array $sidebar
+ * @param array &$sidebar
* @return bool
*/
public static function SkinBuildSidebar( $skin, &$sidebar ) {
@@ -42,8 +44,8 @@
* Pop some ads into the start of the content area
*
* @global string $wgAdManagerPlacement
- * @param OutputPage $out
- * @param Skin $skin
+ * @param OutputPage &$out
+ * @param Skin &$skin
* @return bool
*/
public static function onBeforePageDisplay( OutputPage &$out, Skin
&$skin ) {
diff --git a/AdManagerZones.class.php b/AdManagerZones.class.php
index 52fff18..b94aefd 100644
--- a/AdManagerZones.class.php
+++ b/AdManagerZones.class.php
@@ -174,14 +174,14 @@
}
$success = $dbw->insert( self::getTableName(), $rows,
__METHOD__, 'IGNORE' );
- // DatabaseBase::insert does not always return true for success
as documented...
+ // Database::insert does not always return true for success as
documented...
return $success !== false;
}
/**
* Remove zones from the db
*
- * return bool True if all zones were removed
+ * @return bool True if all zones were removed
*/
protected function doRemoveZones() {
$successAll = true;
@@ -203,14 +203,14 @@
}
/**
- * @return DatabaseBase Read-only db connection
+ * @return IDatabase Read-only db connection
*/
public static function getReadDbConnection() {
return wfGetDB( DB_REPLICA );
}
/**
- * @return DatabaseBase Writable db connection
+ * @return IDatabase Writable db connection
*/
public static function getWriteDbConnection() {
return wfGetDB( DB_MASTER );
--
To view, visit https://gerrit.wikimedia.org/r/399878
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I7ffe408d1c9108b087f54af259c65f9457c4b15d
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/AdManager
Gerrit-Branch: master
Gerrit-Owner: Umherirrender <umherirrender_de...@web.de>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
