php docs of functions should have newline in it and not in one line.
Change-Id: If4a29aefb46a7f73d75593814e597fdb792d5470
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' );
}
* @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 );
}
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" );
return $skin;
}
- /** @return string skin name */
+ /**
+ * @return string skin name
+ */
public function getSkinName() {
return $this->skinname;
}
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();
}
$this->output( "Done!\n" );
}
- /** Purge URL coming from stdin */
+ /**
+ * Purge URL coming from stdin
+ */
private function doPurge() {
$stdin = $this->getStdin();
$urls = array();
$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;
$this->description = $description;
}
- /** Whether the test passed */
+ /**
+ * Whether the test passed
+ * @return bool
+ */
public function isSuccess() {
return $this->expected === $this->actual;
}