This is a pure documentation change. It mostly removes empty lines from
comments (and entirely empty comments), as well as adds a few missing
documentation blocks and fixes a minor mistake. I hope it's ok to have
this in one patch. I can split it, please tell me.
Change-Id: I9668338602ac77b903ab6b02ff56bd52743c37c4
38 files changed:
* $a = $cf->run();
* print implode( ',' , $a );
* @endcode
* $a = $cf->run();
* print implode( ',' , $a );
* @endcode
*/
class CategoryFinder {
/** @var int[] The original article IDs passed to the seed function */
*/
class CategoryFinder {
/** @var int[] The original article IDs passed to the seed function */
* is in this case an unwanted overhead that just slows things down.
*
* @warning EXPERIMENTAL!
* is in this case an unwanted overhead that just slows things down.
*
* @warning EXPERIMENTAL!
*/
$wgDBOracleDRCP = false;
*/
$wgDBOracleDRCP = false;
*
* These are synonyms for the names given in the language file
* Users and translators should not change them
*
* These are synonyms for the names given in the language file
* Users and translators should not change them
* Gives access to properties of a page.
*
* @since 1.27
* Gives access to properties of a page.
*
* @since 1.27
*
* @return string The content model id associated with this revision,
* see the CONTENT_MODEL_XXX constants.
*
* @return string The content model id associated with this revision,
* see the CONTENT_MODEL_XXX constants.
public function getContentModel() {
if ( !$this->mContentModel ) {
$title = $this->getTitle();
public function getContentModel() {
if ( !$this->mContentModel ) {
$title = $this->getTitle();
*
* @return string The content format id associated with this revision,
* see the CONTENT_FORMAT_XXX constants.
*
* @return string The content format id associated with this revision,
* see the CONTENT_FORMAT_XXX constants.
public function getContentFormat() {
if ( !$this->mContentFormat ) {
$handler = $this->getContentHandler();
public function getContentFormat() {
if ( !$this->mContentFormat ) {
$handler = $this->getContentHandler();
/**
* Update object handling the cleanup of links tables after a page was deleted.
/**
* Update object handling the cleanup of links tables after a page was deleted.
class LinksDeletionUpdate extends DataUpdate implements EnqueueableDataUpdate {
/** @var WikiPage */
protected $page;
class LinksDeletionUpdate extends DataUpdate implements EnqueueableDataUpdate {
/** @var WikiPage */
protected $page;
return strlen( $content );
}
return strlen( $content );
}
+ /**
+ * @see MWHttpRequest::execute
+ *
+ * @throws MWException
+ * @return Status
+ */
public function execute() {
$this->prepare();
public function execute() {
$this->prepare();
$this->fopenErrors += [ "errno$n" => $errno, "errstr$n" => $errstr ];
}
$this->fopenErrors += [ "errno$n" => $errno, "errstr$n" => $errstr ];
}
+ /**
+ * @see MWHttpRequest::execute
+ *
+ * @return Status
+ */
public function execute() {
$this->prepare();
public function execute() {
$this->prepare();
*
* @param $serverSoftware
* @return bool
*
* @param $serverSoftware
* @return bool
*/
public static function haveUndecodedRequestUri( $serverSoftware ) {
static $whitelist = [
*/
public static function haveUndecodedRequestUri( $serverSoftware ) {
static $whitelist = [
private function elementClose() {
list( $name, $attribs ) = array_pop( $this->elementDataContext );
$data = array_pop( $this->elementData );
private function elementClose() {
list( $name, $attribs ) = array_pop( $this->elementDataContext );
$data = array_pop( $this->elementData );
*
* @param string|array $key The metric(s) to set.
* @param float $time The elapsed time (ms) to log
*
* @param string|array $key The metric(s) to set.
* @param float $time The elapsed time (ms) to log
public function timing( $key, $time ) {
}
public function timing( $key, $time ) {
}
*
* @param string|array $key The metric(s) to set.
* @param float $value The value for the stats.
*
* @param string|array $key The metric(s) to set.
* @param float $value The value for the stats.
public function gauge( $key, $value ) {
}
public function gauge( $key, $value ) {
}
* @param float $value The value for the stats.
*
* @return array
* @param float $value The value for the stats.
*
* @return array
public function set( $key, $value ) {
return [];
}
public function set( $key, $value ) {
return [];
}
* @param float|1 $sampleRate The rate (0-1) for sampling.
*
* @return array
* @param float|1 $sampleRate The rate (0-1) for sampling.
*
* @return array
public function increment( $key ) {
return [];
}
public function increment( $key ) {
return [];
}
* @param float|1 $sampleRate The rate (0-1) for sampling.
*
* @return mixed
* @param float|1 $sampleRate The rate (0-1) for sampling.
*
* @return mixed
public function decrement( $key ) {
return [];
}
public function decrement( $key ) {
return [];
}
* @param integer $delta The delta to add to the each metric
*
* @return mixed
* @param integer $delta The delta to add to the each metric
*
* @return mixed
public function updateCount( $key, $delta ) {
return [];
}
public function updateCount( $key, $delta ) {
return [];
}
* ("c" for count, "ms" for timing, "g" for gauge, "s" for set)
*
* @return StatsdDataInterface
* ("c" for count, "ms" for timing, "g" for gauge, "s" for set)
*
* @return StatsdDataInterface
public function produceStatsdData(
$key,
$value = 1,
public function produceStatsdData(
$key,
$value = 1,
* Note XMP kind of looks like rdf. They are not the same thing - XMP is
* encoded as a specific subset of rdf. This class can read XMP. It cannot
* read rdf.
* Note XMP kind of looks like rdf. They are not the same thing - XMP is
* encoded as a specific subset of rdf. This class can read XMP. It cannot
* read rdf.
*/
class XMPReader implements LoggerAwareInterface {
/** @var array XMP item configuration array */
*/
class XMPReader implements LoggerAwareInterface {
/** @var array XMP item configuration array */
* Called when processing the <rdf:value> or <foo:someQualifier>.
*
* @param string $elm Namespace and tag name separated by a space.
* Called when processing the <rdf:value> or <foo:someQualifier>.
*
* @param string $elm Namespace and tag name separated by a space.
*/
private function startElementModeQDesc( $elm ) {
if ( $elm === self::NS_RDF . ' value' ) {
*/
private function startElementModeQDesc( $elm ) {
if ( $elm === self::NS_RDF . ' value' ) {
* Class to simplify the use of log pages.
* The logs are now kept in a table which is easier to manage and trim
* than ever-growing wiki pages.
* Class to simplify the use of log pages.
* The logs are now kept in a table which is easier to manage and trim
* than ever-growing wiki pages.
*/
class LogPage {
const DELETED_ACTION = 1;
*/
class LogPage {
const DELETED_ACTION = 1;
/**
* Show a diff page according to current request variables. For use within
* Article::view() only, other callers should use the DifferenceEngine class.
/**
* Show a diff page according to current request variables. For use within
* Article::view() only, other callers should use the DifferenceEngine class.
*/
protected function showDiffPage() {
$request = $this->getContext()->getRequest();
*/
protected function showDiffPage() {
$request = $this->getContext()->getRequest();
/**
* @var string Deprecated accessor for the strip marker prefix.
* @deprecated since 1.26; use Parser::MARKER_PREFIX instead.
/**
* @var string Deprecated accessor for the strip marker prefix.
* @deprecated since 1.26; use Parser::MARKER_PREFIX instead.
public $mUniqPrefix = Parser::MARKER_PREFIX;
/**
public $mUniqPrefix = Parser::MARKER_PREFIX;
/**
* @code
* $parser->getOutput()->my_ext_foo = '...';
* @endcode
* @code
* $parser->getOutput()->my_ext_foo = '...';
* @endcode
*/
public function setProperty( $name, $value ) {
$this->mProperties[$name] = $value;
*/
public function setProperty( $name, $value ) {
$this->mProperties[$name] = $value;
public function registerTestModules() {
global $IP;
public function registerTestModules() {
global $IP;
/**
* Augment search results.
/**
* Augment search results.
*/
interface ResultAugmentor {
/**
*/
interface ResultAugmentor {
/**
/**
* Augment search results.
/**
* Augment search results.
*/
interface ResultSetAugmentor {
/**
*/
interface ResultSetAugmentor {
/**
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
/**
* A search suggestion
*/
/**
* A search suggestion
*/
class SearchSuggestion {
/**
*/
class SearchSuggestion {
/**
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
/**
* Executes an edit mode for the watchlist view, from which you can manage your watchlist
/**
* Executes an edit mode for the watchlist view, from which you can manage your watchlist
*/
protected function executeViewEditWatchlist() {
$out = $this->getOutput();
*/
protected function executeViewEditWatchlist() {
$out = $this->getOutput();
* @param string $oname The option to check
* @param string $defaultOverride A default value returned if the option does not exist
* @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
* @param string $oname The option to check
* @param string $defaultOverride A default value returned if the option does not exist
* @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
- * @return string User's current value for the option
+ * @return string|null User's current value for the option
* @see getBoolOption()
* @see getIntOption()
*/
* @see getBoolOption()
* @see getIntOption()
*/
*
* Only a functional interface is provided: ZipFileReader::read(). No access is
* given to object instances.
*
* Only a functional interface is provided: ZipFileReader::read(). No access is
* given to object instances.
*/
class ZipDirectoryReader {
/**
*/
class ZipDirectoryReader {
/**
use \Cdb\Exception as CdbException;
use \Cdb\Reader as CdbReader;
use \Cdb\Exception as CdbException;
use \Cdb\Reader as CdbReader;
require_once __DIR__ . '/commandLine.inc';
function cdbShowHelp( $command ) {
require_once __DIR__ . '/commandLine.inc';
function cdbShowHelp( $command ) {
$optionsWithArgs = [ 'd' ];
$optionsWithArgs = [ 'd' ];
require_once __DIR__ . "/commandLine.inc";
if ( isset( $options['d'] ) ) {
require_once __DIR__ . "/commandLine.inc";
if ( isset( $options['d'] ) ) {
class CompressOld extends Maintenance {
/**
* Option to load each revision individually.
class CompressOld extends Maintenance {
/**
* Option to load each revision individually.
*/
const LS_INDIVIDUAL = 0;
/**
* Option to load revisions in chunks.
*/
const LS_INDIVIDUAL = 0;
/**
* Option to load revisions in chunks.
* $('#textbox').expandableField();
*
* Options:
* $('#textbox').expandableField();
*
* Options:
* @param {mw.Title} title Title being posted to
* @param {mw.Api} api mw.Api instance that the instance should use
* @return {mw.messagePoster.MessagePoster}
* @param {mw.Title} title Title being posted to
* @param {mw.Api} api mw.Api instance that the instance should use
* @return {mw.messagePoster.MessagePoster}
*/
MessagePosterFactory.prototype.createForContentModel = function ( contentModel, title, api ) {
return new this.contentModelToClass[ contentModel ]( title, api );
*/
MessagePosterFactory.prototype.createForContentModel = function ( contentModel, title, api ) {
return new this.contentModelToClass[ contentModel ]( title, api );
$checkboxes.prop( 'disabled', isAllNS );
},
$checkboxes.prop( 'disabled', isAllNS );
},
init: function () {
$select = $( '#namespace' );
$checkboxes = $( '#nsassociated, #nsinvert' );
init: function () {
$select = $( '#namespace' );
$checkboxes = $( '#nsassociated, #nsinvert' );
/**
* Internal helper that actually run the test.
* Called by the public methods testEncodingUrlWith...()
/**
* Internal helper that actually run the test.
* Called by the public methods testEncodingUrlWith...()
*/
private function verifyEncodingFor( $server, $input, $expectations ) {
$expected = $this->extractExpect( $server, $expectations );
*/
private function verifyEncodingFor( $server, $input, $expectations ) {
$expected = $this->extractExpect( $server, $expectations );
* Generated by PHPUnit on 2011-02-20 at 21:01:55.
* @todo covers tags
* @todo FIXME: this test file is a mess
* Generated by PHPUnit on 2011-02-20 at 21:01:55.
* @todo covers tags
* @todo FIXME: this test file is a mess
*/
class MWNamespaceTest extends MediaWikiTestCase {
protected function setUp() {
*/
class MWNamespaceTest extends MediaWikiTestCase {
protected function setUp() {
* @group Output
*
* @todo factor tests in this class into providers and test methods
* @group Output
*
* @todo factor tests in this class into providers and test methods
*/
class OutputPageTest extends MediaWikiTestCase {
const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
*/
class OutputPageTest extends MediaWikiTestCase {
const SCREEN_MEDIA_QUERY = 'screen and (min-width: 982px)';
return $this->getTokenList( self::$users['sysop'] );
}
return $this->getTokenList( self::$users['sysop'] );
}
public function testWatchEdit() {
$tokens = $this->getTokens();
public function testWatchEdit() {
$tokens = $this->getTokens();
public function testWatchProtect() {
$tokens = $this->getTokens();
public function testWatchProtect() {
$tokens = $this->getTokens();
$this->assertArrayHasKey( 'edit', $data[0]['protect']['protections'][0] );
}
$this->assertArrayHasKey( 'edit', $data[0]['protect']['protections'][0] );
}
public function testGetRollbackToken() {
$this->getTokens();
public function testGetRollbackToken() {
$this->getTokens();
* @group Database
* ^--- important, causes temporary tables to be used instead of the real database
* @group medium
* @group Database
* ^--- important, causes temporary tables to be used instead of the real database
* @group medium
class WikiPageTest extends MediaWikiLangTestCase {
protected $pages_to_delete;
class WikiPageTest extends MediaWikiLangTestCase {
protected $pages_to_delete;
* Due to a hack in Maintenance.php using register_shutdown_function, be sure to
* finally call simulateShutdown on MaintenanceFixup instance before a test
* ends.
* Due to a hack in Maintenance.php using register_shutdown_function, be sure to
* finally call simulateShutdown on MaintenanceFixup instance before a test
* ends.
*/
class MaintenanceFixup extends Maintenance {
*/
class MaintenanceFixup extends Maintenance {
/**
* Creates an empty Content object of the type supported by this ContentHandler.
/**
* Creates an empty Content object of the type supported by this ContentHandler.
*/
public function makeEmptyContent() {
return new DummyContentForTesting( '' );
*/
public function makeEmptyContent() {
return new DummyContentForTesting( '' );
* @copyright © 2012, Niklas Laxström
* @copyright © 2012, Santhosh Thottingal
* @copyright © 2012, Timo Tijhof
* @copyright © 2012, Niklas Laxström
* @copyright © 2012, Santhosh Thottingal
* @copyright © 2012, Timo Tijhof
*/
class ResourcesTest extends MediaWikiTestCase {
*/
class ResourcesTest extends MediaWikiTestCase {