Umherirrender has uploaded a new change for review.
https://gerrit.wikimedia.org/r/118935
Change subject: Fix formatting of some php docs
......................................................................
Fix formatting of some php docs
php docs of functions should have newline in it and not in one line.
Change-Id: If4a29aefb46a7f73d75593814e597fdb792d5470
---
M includes/Category.php
M includes/FormOptions.php
M includes/HistoryBlob.php
M includes/Skin.php
M includes/WatchedItem.php
M maintenance/purgeList.php
M tests/parser/ParserTestResult.php
7 files changed, 58 insertions(+), 17 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/core
refs/changes/35/118935/1
diff --git a/includes/Category.php b/includes/Category.php
index 126b8fe..df5ad7d 100644
--- a/includes/Category.php
+++ b/includes/Category.php
@@ -195,27 +195,37 @@
return $cat;
}
- /** @return mixed DB key name, or false on failure */
+ /**
+ * @return mixed DB key name, or false on failure
+ */
public function getName() {
return $this->getX( 'mName' );
}
- /** @return mixed Category ID, or false on failure */
+ /**
+ * @return mixed Category ID, or false on failure
+ */
public function getID() {
return $this->getX( 'mID' );
}
- /** @return mixed Total number of member pages, or false on failure */
+ /**
+ * @return mixed Total number of member pages, or false on failure
+ */
public function getPageCount() {
return $this->getX( 'mPages' );
}
- /** @return mixed Number of subcategories, or false on failure */
+ /**
+ * @return mixed Number of subcategories, or false on failure
+ */
public function getSubcatCount() {
return $this->getX( 'mSubcats' );
}
- /** @return mixed Number of member files, or false on failure */
+ /**
+ * @return mixed Number of member files, or false on failure
+ */
public function getFileCount() {
return $this->getX( 'mFiles' );
}
diff --git a/includes/FormOptions.php b/includes/FormOptions.php
index cd6e207..a8da67e 100644
--- a/includes/FormOptions.php
+++ b/includes/FormOptions.php
@@ -373,22 +373,32 @@
* @see http://php.net/manual/en/class.arrayaccess.php
*/
/* @{ */
- /** Whether the option exists. */
+ /**
+ * Whether the option exists.
+ * @return bool
+ */
public function offsetExists( $name ) {
return isset( $this->options[$name] );
}
- /** Retrieve an option value. */
+ /**
+ * Retrieve an option value.
+ * @return mixed
+ */
public function offsetGet( $name ) {
return $this->getValue( $name );
}
- /** Set an option to given value. */
+ /**
+ * Set an option to given value.
+ */
public function offsetSet( $name, $value ) {
$this->setValue( $name, $value );
}
- /** Delete the option. */
+ /**
+ * Delete the option.
+ */
public function offsetUnset( $name ) {
$this->delete( $name );
}
diff --git a/includes/HistoryBlob.php b/includes/HistoryBlob.php
index 9c50895..a3ed700 100644
--- a/includes/HistoryBlob.php
+++ b/includes/HistoryBlob.php
@@ -78,7 +78,9 @@
public $mMaxSize = 10000000;
public $mMaxCount = 100;
- /** Constructor */
+ /**
+ * Constructor
+ */
public function __construct() {
if ( !function_exists( 'gzdeflate' ) ) {
throw new MWException( "Need zlib support to read or
write this kind of history object (ConcatenatedGzipHistoryBlob)\n" );
diff --git a/includes/Skin.php b/includes/Skin.php
index 6722cca..5fa01ae 100644
--- a/includes/Skin.php
+++ b/includes/Skin.php
@@ -182,7 +182,9 @@
return $skin;
}
- /** @return string skin name */
+ /**
+ * @return string skin name
+ */
public function getSkinName() {
return $this->skinname;
}
diff --git a/includes/WatchedItem.php b/includes/WatchedItem.php
index fe97843..a6e7516 100644
--- a/includes/WatchedItem.php
+++ b/includes/WatchedItem.php
@@ -70,16 +70,26 @@
return $this->mTitle;
}
- /** Helper to retrieve the title namespace */
+ /**
+ * Helper to retrieve the title namespace
+ * @return int
+ */
protected function getTitleNs() {
return $this->getTitle()->getNamespace();
}
- /** Helper to retrieve the title DBkey */
+ /**
+ * Helper to retrieve the title DBkey
+ * @return string
+ */
protected function getTitleDBkey() {
return $this->getTitle()->getDBkey();
}
- /** Helper to retrieve the user id */
+
+ /**
+ * Helper to retrieve the user id
+ * @return int
+ */
protected function getUserId() {
return $this->mUser->getId();
}
diff --git a/maintenance/purgeList.php b/maintenance/purgeList.php
index 2f89520..85a125f 100644
--- a/maintenance/purgeList.php
+++ b/maintenance/purgeList.php
@@ -51,7 +51,9 @@
$this->output( "Done!\n" );
}
- /** Purge URL coming from stdin */
+ /**
+ * Purge URL coming from stdin
+ */
private function doPurge() {
$stdin = $this->getStdin();
$urls = array();
@@ -78,7 +80,9 @@
$this->sendPurgeRequest( $urls );
}
- /** Purge a namespace or all pages */
+ /**
+ * Purge a namespace or all pages
+ */
private function purgeNamespace( $namespace = false ) {
$dbr = wfGetDB( DB_SLAVE );
$startId = 0;
diff --git a/tests/parser/ParserTestResult.php
b/tests/parser/ParserTestResult.php
index d9ad773..7b0fc44 100644
--- a/tests/parser/ParserTestResult.php
+++ b/tests/parser/ParserTestResult.php
@@ -35,7 +35,10 @@
$this->description = $description;
}
- /** Whether the test passed */
+ /**
+ * Whether the test passed
+ * @return bool
+ */
public function isSuccess() {
return $this->expected === $this->actual;
}
--
To view, visit https://gerrit.wikimedia.org/r/118935
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: If4a29aefb46a7f73d75593814e597fdb792d5470
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/core
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
