/** Add misc metadata. Warning: atm if the metadata category
* doesn't have a priority, it will be silently discarded.
*
- * @param array $metaArray array of metadata values
+ * @param array $meta Array of metadata values
* @param string $type Type. defaults to other. if two things have the same type they're merged
*/
function addMetadata( $metaArray, $type = 'other' ) {
/** Main entry point for jpeg's.
*
- * @param string $filename filename (with full path)
+ * @param string $filename Filename (with full path)
* @return array Metadata result array.
- * @throws MWException on invalid file.
+ * @throws MWException On invalid file.
*/
static function Jpeg( $filename ) {
$showXMP = function_exists( 'xml_parser_create_ns' );
* They don't really have native metadata, so just merges together
* XMP and image comment.
*
- * @param string $filename full path to file
+ * @param string $filename Full path to file
* @return array Metadata array
*/
public static function GIF( $filename ) {
// something that explicitly initializes local variables.
extract( unpack( 'a4magic/a4chunk/NchunkLength', $header ) );
/** @var string $chunk
- * @var string $chunkLength */
+ * @var string $chunkLength */
echo "$chunk $chunkLength\n";
$this->dumpForm( $file, $chunkLength, 1 );
fclose( $file );
// something that explicitly initializes local variables.
extract( unpack( 'a4chunk/NchunkLength', $chunkHeader ) );
/** @var string $chunk
- * @var string $chunkLength */
+ * @var string $chunkLength */
echo str_repeat( ' ', $indent * 4 ) . "$chunk $chunkLength\n";
if ( $chunk == 'FORM' ) {
extract( unpack( 'a4magic/a4form/NformLength/a4subtype', $header ) );
/** @var string $magic
- * @var string $subtype
- * @var string $formLength
- * @var string $formType */
+ * @var string $subtype
+ * @var string $formLength
+ * @var string $formType */
if ( $magic != 'AT&T' ) {
wfDebug( __METHOD__ . ": not a DjVu file\n" );
} elseif ( $subtype == 'DJVU' ) {
extract( unpack( 'a4chunk/Nlength', $header ) );
/** @var string $chunk
- * @var string $length */
+ * @var string $length */
return array( $chunk, $length );
}
}
# Newer files have rotation info in byte 10, but we don't use it yet.
/** @var string $width
- * @var string $height
- * @var string $major
- * @var string $minor
- * @var string $resolution
- * @var string $length
- * @var string $gamma */
+ * @var string $height
+ * @var string $major
+ * @var string $minor
+ * @var string $resolution
+ * @var string $length
+ * @var string $gamma */
return array(
'width' => $width,
'height' => $height,
* Do userComment tags and similar. See pg. 34 of exif standard.
* basically first 8 bytes is charset, rest is value.
* This has not been tested on any shift-JIS strings.
- * @param string $prop prop name.
+ * @param string $prop Prop name
*/
private function charCodeString( $prop ) {
if ( isset( $this->mFilteredExifData[$prop] ) ) {
/**
* Validates if a tag has a legal value according to the Exif spec
*
- * @param string $section section where tag is located.
- * @param string $tag the tag to check.
+ * @param string $section Section where tag is located.
+ * @param string $tag The tag to check.
* @param mixed $val The value of the tag.
* @param bool $recursive True if called recursively for array types.
* @return bool
/**
* Convenience function for debugging output
*
- * @param string $fname the name of the function calling this function
+ * @param string $fname The name of the function calling this function
* @param bool $io Specify whether we're beginning or ending
*/
private function debugFile( $fname, $io ) {
*
* This is the usual entry point for this class.
*
- * @param array $tags the Exif data to format ( as returned by
+ * @param array $tags The Exif data to format ( as returned by
* Exif::getFilteredData() or BitmapMetadataHandler )
* @param bool|IContextSource $context Context to use (optional)
* @return array
* value which most of the time are plain integers. This function
* formats Exif (and other metadata) values into human readable form.
*
- * @param array $tags the Exif data to format ( as returned by
+ * @param array $tags The Exif data to format ( as returned by
* Exif::getFilteredData() or BitmapMetadataHandler )
* @return array
* @since 1.23
/**
* Flatten an array, using the user language for any messages.
*
- * @param array $vals array of values
+ * @param array $vals Array of values
* @param string $type Type of array (either lang, ul, ol).
* lang = language assoc array with keys being the lang code
* ul = unordered list, ol = ordered list
*
* This is public on the basis it might be useful outside of this class.
*
- * @param array $vals array of values
+ * @param array $vals Array of values
* @param string $type Type of array (either lang, ul, ol).
* lang = language assoc array with keys being the lang code
* ul = unordered list, ol = ordered list
*
* @param File $file File to use
* @param array $extendedMetadata
- * @param int $maxCacheTime hook handlers might use this parameter to override cache time
+ * @param int $maxCacheTime Hook handlers might use this parameter to override cache time
*
* @return array [<property name> => ['value' => <value>]], or [] on error
* @since 1.23
* If the value is not a multilang array, it is returned unchanged.
* See mediawiki.org/wiki/Manual:File_metadata_handling#Multi-language_array_format
* @param mixed $value
- * @return mixed value in best language, null if there were no languages at all
+ * @return mixed Value in best language, null if there were no languages at all
* @since 1.23
*/
protected function resolveMultilangValue( $value ) {
*
* @see http://www.iptc.org/std/IIM/4.1/specification/IIMV4.1.pdf
*
- * @param string $rawData app13 block from jpeg containing iptc/iim data
+ * @param string $rawData The app13 block from jpeg containing iptc/iim data
* @return array IPTC metadata array
*/
static function parse( $rawData ) {
/**
* take the value of 1:90 tag and returns a charset
* @param string $tag 1:90 tag.
- * @return string charset name or "?"
+ * @return string Charset name or "?"
* Warning, this function does not (and is not intended to) detect
* all iso 2022 escape codes. In practise, the code for utf-8 is the
* only code that seems to have wide use. It does detect that code.
}
/** Validate and normalize quality value to be between 1 and 100 (inclusive).
- * @param int $value quality value, will be converted to integer or 0 if invalid
- * @return bool true if the value is valid
+ * @param int $value Quality value, will be converted to integer or 0 if invalid
+ * @return bool True if the value is valid
*/
private static function validateQuality( $value ) {
return $value === 'low';
* but gis doesn't support having multiple app1 segments
* and those can't extract xmp on files containing both exif and xmp data
*
- * @param string $filename name of jpeg file
- * @return array of interesting segments.
- * @throws MWException if given invalid file.
+ * @param string $filename Name of jpeg file
+ * @return array Array of interesting segments.
+ * @throws MWException If given invalid file.
*/
static function segmentSplitter( $filename ) {
$showXMP = function_exists( 'xml_parser_create_ns' );
*
* This should generally be called by BitmapMetadataHandler::doApp13()
*
- * @param string $app13 photoshop psir app13 block from jpg.
+ * @param string $app13 Photoshop psir app13 block from jpg.
* @throws MWException (It gets caught next level up though)
* @return string If the iptc hash is good or not. One of 'iptc-no-hash',
* 'iptc-good-hash', 'iptc-bad-hash'.
* first page.
*
* @param File $image The image object, or false if there isn't one
- * @param string $path the filename
+ * @param string $path The filename
* @return array Follow the format of PHP getimagesize() internal function.
* See http://www.php.net/getimagesize. MediaWiki will only ever use the
* first two array keys (the width and height), and the 'bits' associative
* @param string $ext Extension of original file
* @param string $mime MIME type of original file
* @param array $params Handler specific rendering parameters
- * @return array thumbnail extension and MIME type
+ * @return array Thumbnail extension and MIME type
*/
function getThumbType( $ext, $mime, $params = null ) {
$magic = MimeMagic::singleton();
* relevant errors.
*
* @param string $fileName The local path to the file.
- * @return Status object
+ * @return Status
*/
function verifyUpload( $fileName ) {
return Status::newGood();
/**
* Returns whether or not this handler supports the chained generation of thumbnails according
* to buckets
- * @return boolean
- * @since 1.24
+ * @return bool
+ * @since 1.24
*/
public function supportsBucketing() {
return false;
*/
public $responsiveUrls = array();
- /** @var File object */
+ /** @var File */
protected $file;
/** @var int Image width */
}
/**
- * @return File file
+ * @return File
*/
public function getFile() {
return $this->file;
/**
* We do not support making APNG thumbnails, so always false
* @param File $image
- * @return bool false
+ * @return bool False
*/
function canAnimateThumbnail( $image ) {
return false;
*
* @param resource $fh The file handle
* @param int $size Size in bytes.
- * @throws Exception if too big.
+ * @throws Exception If too big
* @return string The chunk.
*/
private static function read( $fh, $size ) {
}
/**
- * @param array $params name=>value pairs of parameters
+ * @param array $params Name=>value pairs of parameters
* @return string Filename to use
*/
function makeParamString( $params ) {
* @author Hashar
*
* @param string $filename Full path to a XCF file
- * @return bool|array metadata array just like PHP getimagesize()
+ * @return bool|array Metadata Array just like PHP getimagesize()
*/
static function getXCFMetaData( $filename ) {
# Decode master structure
*
* @param XMLParser $parser XMLParser reference to the xml parser
* @param string $data Character data
- * @throws MWException on invalid data
+ * @throws MWException On invalid data
*/
function char( $parser, $data ) {
* this should always be <rdf:Bag>
*
* @param string $elm Namespace . ' ' . tag
- * @throws MWException if we have an element that's not <rdf:Bag>
+ * @throws MWException If we have an element that's not <rdf:Bag>
*/
private function startElementModeBag( $elm ) {
if ( $elm === self::NS_RDF . ' Bag' ) {
* this should always be <rdf:Seq>
*
* @param string $elm Namespace . ' ' . tag
- * @throws MWException if we have an element that's not <rdf:Seq>
+ * @throws MWException If we have an element that's not <rdf:Seq>
*/
private function startElementModeSeq( $elm ) {
if ( $elm === self::NS_RDF . ' Seq' ) {
* we don't care about.
*
* @param string $elm Namespace . ' ' . tag
- * @throws MWException if we have an element that's not <rdf:Alt>
+ * @throws MWException If we have an element that's not <rdf:Alt>
*/
private function startElementModeLang( $elm ) {
if ( $elm === self::NS_RDF . ' Alt' ) {
*
* @param string $elm Namespace . ' ' . tagname
* @param array $attribs Attributes. (needed for BAGSTRUCTS)
- * @throws MWException if gets a tag other than <rdf:li>
+ * @throws MWException If gets a tag other than <rdf:li>
*/
private function startElementModeLi( $elm, $attribs ) {
if ( ( $elm ) !== self::NS_RDF . ' li' ) {
* Batch insertion
* @param array $data $key => $value assoc array
* @param int $exptime Either an interval in seconds or a unix timestamp for expiry
- * @return bool success
+ * @return bool Success
* @since 1.24
*/
public function setMulti( array $data, $exptime = 0 ) {
* This will create the key with value $init and TTL $ttl if not present
*
* @param string $key
- * @param integer $ttl
- * @param integer $value
- * @param integer $init
+ * @param int $ttl
+ * @param int $value
+ * @param int $init
* @return bool
* @since 1.24
*/
* Store a value in the WinCache object cache
*
* @param string $key Cache key
- * @param mixed $valueObject to store
+ * @param mixed $valueObject Value to store
* @param int $expire Expiration time
* @return bool
*/
* If the revision requested for view is deleted, check permissions.
* Send either an error message or a warning header to the output.
*
- * @return bool true if the view is allowed, false if not.
+ * @return bool True if the view is allowed, false if not.
*/
public function showDeletedRevisionHeader() {
if ( !$this->mRevision->isDeleted( Revision::DELETED_TEXT ) ) {
* output to the client that is necessary for this request.
* (that is, it has sent a cached version of the page)
*
- * @return bool true if cached version send, false otherwise
+ * @return bool True if cached version send, false otherwise
*/
protected function tryFileCache() {
static $called = false;
* Override the ParserOptions used to render the primary article wikitext.
*
* @param ParserOptions $options
- * @throws MWException if the parser options where already initialized.
+ * @throws MWException If the parser options where already initialized.
*/
public function setParserOptions( ParserOptions $options ) {
if ( $this->mParserOptions ) {
* of the dimensions are bigger than the max, or if the
* image is vectorized.
*
- * @param $maxWidth integer Max width to display at
- * @param $maxHeight integer Max height to display at
- * @param $width integer Actual width of the image
- * @param $height integer Actual height of the image
+ * @param int $maxWidth Max width to display at
+ * @param int $maxHeight Max height to display at
+ * @param int $width Actual width of the image
+ * @param int $height Actual height of the image
* @throws MWException
- * @return Array (width, height)
+ * @return array Array (width, height)
*/
protected function getDisplayWidthHeight( $maxWidth, $maxHeight, $width, $height ) {
if ( !$maxWidth || !$maxHeight ) {
* Get alternative thumbnail sizes.
*
* @note This will only list several alternatives if thumbnails are rendered on 404
- * @param $origWidth Actual width of image
- * @param $origHeight Actual height of image
- * @return Array An array of [width, height] pairs.
+ * @param int $origWidth Actual width of image
+ * @param int $origHeight Actual height of image
+ * @return array An array of [width, height] pairs.
*/
protected function getThumbSizes( $origWidth, $origHeight ) {
global $wgImageLimits;
/**
* Loads page_touched and returns a value indicating if it should be used
- * @return bool true if not a redirect
+ * @return bool True if not a redirect
*/
public function checkTouched() {
if ( !$this->mDataLoaded ) {
/**
* Get the page_latest field
- * @return int rev_id of current revision
+ * @return int The rev_id of current revision
*/
public function getLatest() {
if ( !$this->mDataLoaded ) {
/**
* Get the content of the current revision. No side-effects...
*
- * @param int $audience int One of:
+ * @param int $audience One of:
* Revision::FOR_PUBLIC to be displayed to all users
* Revision::FOR_THIS_USER to be displayed to $wgUser
* Revision::RAW get the text regardless of permissions
* Revision::RAW get the text regardless of permissions
* @param User $user User object to check for, only if FOR_THIS_USER is passed
* to the $audience parameter
- * @return int user ID for the user that made the last article revision
+ * @return int User ID for the user that made the last article revision
*/
public function getUser( $audience = Revision::FOR_PUBLIC, User $user = null ) {
$this->loadLastEdit();
* Revision::RAW get the text regardless of permissions
* @param User $user User object to check for, only if FOR_THIS_USER is passed
* to the $audience parameter
- * @return string username of the user that made the last article revision
+ * @return string Username of the user that made the last article revision
*/
public function getUserText( $audience = Revision::FOR_PUBLIC, User $user = null ) {
$this->loadLastEdit();
/**
* Get the Title object or URL this page redirects to
*
- * @return bool|Title|string false, Title of in-wiki target, or string with URL
+ * @return bool|Title|string False, Title of in-wiki target, or string with URL
*/
public function followRedirect() {
return $this->getRedirectURL( $this->getRedirectTarget() );
* objects for same-wiki, non-special redirects and URLs for everything
* else.
* @param Title $rt Redirect target
- * @return bool|Title|string false, Title object of local target, or string with URL
+ * @return bool|Title|string False, Title object of local target, or string with URL
*/
public function getRedirectURL( $rt ) {
if ( !$rt ) {
* Giving 0 indicates the new page flag should be set on.
* @param bool $lastRevIsRedirect If given, will optimize adding and
* removing rows in redirect table.
- * @return bool true on success, false on failure
+ * @return bool True on success, false on failure
*/
public function updateRevisionOn( $dbw, $revision, $lastRevision = null,
$lastRevIsRedirect = null
* or NULL if this is not a redirect
* @param null|bool $lastRevIsRedirect If given, will optimize adding and
* removing rows in redirect table.
- * @return bool true on success, false on failure
+ * @return bool True on success, false on failure
* @private
*/
public function updateRedirectOn( $dbw, $redirectTitle, $lastRevIsRedirect = null ) {
* must exist and must not be deleted
* @param Revision $undo
* @param Revision $undoafter Must be an earlier revision than $undo
- * @return mixed string on success, false on failure
+ * @return mixed String on success, false on failure
* @since 1.21
* Before we had the Content object, this was done in getUndoText
*/
* must exist and must not be deleted
* @param Revision $undo
* @param Revision $undoafter Must be an earlier revision than $undo
- * @return string|bool string on success, false on failure
+ * @return string|bool String on success, false on failure
* @deprecated since 1.21: use ContentHandler::getUndoContent() instead.
*/
public function getUndoText( Revision $undo, Revision $undoafter = null ) {
* or 'new' for a new section.
* @param Content $sectionContent New content of the section.
* @param string $sectionTitle New section's subject, only if $section is "new".
- * @param string $baseRevId integer|null
+ * @param int|null $baseRevId
*
* @throws MWException
* @return Content New complete article content, or null if error.
* @param User $user The user doing the edit
*
* @throws MWException
- * @return Status object. Possible errors:
+ * @return Status Possible errors:
* edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
* set the fatal flag of $status
* edit-gone-missing: In update mode, but the article didn't exist.
* database.
*
* @throws MWException
- * @return Status object. Possible errors:
+ * @return Status Possible errors:
* edit-hook-aborted: The ArticleSave hook aborted the edit but didn't
* set the fatal flag of $status.
* edit-gone-missing: In update mode, but the article didn't exist.
*
* @param Content $content Content submitted
* @param User $user The relevant user
- * @param string $comment comment submitted
+ * @param string $comment Comment submitted
* @param string $serialisation_format Format for storing the content in the database
* @param bool $minor Whereas it's a minor modification
*/
* @param bool $commit Defaults to true, triggers transaction end
* @param array &$error Array of errors to append to
* @param User $user The deleting user
- * @return bool true if successful
+ * @return bool True if successful
*/
public function doDeleteArticle(
$reason, $suppress = false, $id = 0, $commit = true, &$error = '', User $user = null
/**
* Do some database updates after deletion
*
- * @param int $id page_id value of the page being deleted
+ * @param int $id The page_id value of the page being deleted
* @param Content $content Optional page content to be used when determining
* the required updates. This may be needed because $this->getContent()
* may already return null when the page proper was deleted.
* @param string $token Rollback token.
* @param bool $bot If true, mark all reverted edits as bot.
*
- * @param array $resultDetails contains result-specific array of additional values
+ * @param array $resultDetails Array contains result-specific array of additional values
* 'alreadyrolled' : 'current' (rev)
* success : 'summary' (str), 'current' (rev), 'target' (rev)
*
* @param int &$cascade Set to false if cascading protection isn't allowed.
* @param array $expiry Per restriction type expiration
* @param User $user The user updating the restrictions
- * @return bool true on success
+ * @return bool True on success
*/
public function updateRestrictions(
$limit = array(), $reason = '', &$cascade = 0, $expiry = array(), User $user = null
*
* @param Language|string|null $lang In which language to format the date
* Defaults to the site content language
- * @return DateFormatter object
+ * @return DateFormatter
*/
public static function &getInstance( $lang = null ) {
global $wgMemc, $wgContLang;
/**
* Replace <!--LINK--> link placeholders with actual links, in the buffer
*
- * @param $text
+ * @param string $text
* @return array Array of link CSS classes, indexed by PDBK.
*/
function replace( &$text ) {
var $mLangLinkLanguages;
/**
- * @var boolean Recursive call protection.
+ * @var bool Recursive call protection.
* This variable should be treated as if it were private.
*/
public $mInParse = false;
* Convert wikitext to HTML
* Do not call this function recursively.
*
- * @param string $text text we want to parse
+ * @param string $text Text we want to parse
* @param Title $title
* @param ParserOptions $options
* @param bool $linestart
/**
* Get the ParserOptions object
*
- * @return ParserOptions object
+ * @return ParserOptions
*/
function getOptions() {
return $this->mOptions;
*
* @param string $text
*
- * @return string the altered text
+ * @return string The altered text
*/
function doAllQuotes( $text ) {
wfProfileIn( __METHOD__ );
* @todo document
*/
class ParserCache {
- /** @var MWMemcached */
+ /** @var MWMemcached */
private $mMemc;
/**
* Get an instance of this object
*/
/**
- * \brief Set options of the Parser
+ * @brief Set options of the Parser
*
* All member variables are supposed to be private in theory, although in
* practise this is not the case.
/**
* @param Title $title Title object, must be an interwiki link
- * @throws MWException if given invalid input
+ * @throws MWException If given invalid input
*/
function addInterwikiLink( $title ) {
if ( !$title->isExternal() ) {
* -- this is assumed to have been validated
* (check equal normalisation, etc.)
*
- * @param string $text desired title text
+ * @param string $text Desired title text
*/
public function setDisplayTitle( $text ) {
$this->setTitleText( $text );
/**
* @param string $name The property name to look up.
*
- * @return mixed|false The value previously set using setProperty(). False if null or no value
+ * @return mixed|bool The value previously set using setProperty(). False if null or no value
* was set for the given property name.
*
* @note You need to use getProperties() to check for boolean and null properties.
/**
* @throws MWException
- * @param string|PPNode$root
+ * @param string|PPNode $root
* @param int $flags
* @return string
*/
* Lets another one grab the lock, and returns the workers
* waiting on acquireForAnyone()
*
- * @return Status value is one of Released/NotLocked/Error
+ * @return Status Value is one of Released/NotLocked/Error
*/
abstract public function release();
* the same key can acquire a lock.
*
* @param string $key PoolCounter instance key (any string)
- * @param int $slots the number of slots (max allowed value is 65536)
+ * @param int $slots The number of slots (max allowed value is 65536)
* @return int
*/
protected function hashKeyIntoSlots( $key, $slots ) {
/**
* Begin profiling of a function
- * @param string $functionname name of the function we will profile
+ * @param string $functionname Name of the function we will profile
*/
function wfProfileIn( $functionname ) {
if ( Profiler::$__instance === null ) { // use this directly to reduce overhead
/**
* Stop profiling of a function
- * @param string $functionname name of the function we have profiled
+ * @param string $functionname Name of the function we have profiled
*/
function wfProfileOut( $functionname = 'missing' ) {
if ( Profiler::$__instance === null ) { // use this directly to reduce overhead
/**
* Called by wfProfieOut()
*
- * @param string $functionname
+ * @param string $functionname
*/
abstract public function profileOut( $functionname );
/**
* Add an entry in the debug log file
*
- * @param string $s to output
+ * @param string $s String to output
*/
protected function debug( $s ) {
if ( function_exists( 'wfDebug' ) ) {
* Add an entry in the debug log group
*
* @param string $group Group to send the message to
- * @param string $s to output
+ * @param string $s String to output
*/
protected function debugGroup( $group, $s ) {
if ( function_exists( 'wfDebugLog' ) ) {
* @since 1.24
*/
class TransactionProfiler {
- /** @var float seconds */
+ /** @var float Seconds */
protected $mDBLockThreshold = 3.0;
/** @var array DB/server name => (active trx count, time, DBs involved) */
protected $mDBTrxHoldingLocks = array();
* Update an entry with timing data.
*
* @param string $name Section name
- * @param float $elapsedCpu elapsed CPU time
- * @param float $elapsedWall elapsed wall-clock time
+ * @param float $elapsedCpu Elapsed CPU time
+ * @param float $elapsedWall Elapsed wall-clock time
*/
public function updateRunningEntry( $name, $elapsedCpu, $elapsedWall ) {
// If this is the first measurement for this entry, store plain values.
/**
* Recursive function the format the current profiling array into a tree
*
- * @param array $stack profiling array
+ * @param array $stack Profiling array
* @return array
*/
protected function remapCallTree( array $stack ) {
* @see RecentChange::cleanupForIRC
* @param array $feed The feed, as configured in an associative array
* @param string $line The text to send
- * @return bool success
+ * @return bool Success
*/
public function send( array $feed, $line );
}
*/
protected $testModuleNames = array();
- /** @var array e.g. array( 'source-id' => array( 'loadScript' => 'http://.../load.php' ) ) */
+ /** @var array E.g. array( 'source-id' => array( 'loadScript' => 'http://.../load.php' ) ) */
protected $sources = array();
/** @var bool */
*
* @since 1.24
* @param string $source
- * @throws MWException on an invalid $source name
+ * @throws MWException On an invalid $source name
* @return string
*/
public function getLoadScript( $source ) {
* Build a load.php URL
*
* @since 1.24
- * @param string $source name of the ResourceLoader source
+ * @param string $source Name of the ResourceLoader source
* @param ResourceLoaderContext $context
* @param array $extraQuery
* @return string URL to load.php. May be protocol-relative (if $wgLoadScript is procol-relative)
/**
* Get loader script.
*
- * @return string|false JavaScript code to be added to startup module
+ * @return string|bool JavaScript code to be added to startup module
*/
public function getLoaderScript() {
if ( count( $this->loaderScripts ) === 0 ) {
* @param bool $flip
*
* @return string CSS data in script file
- * @throws MWException if the file doesn't exist
+ * @throws MWException If the file doesn't exist
*/
protected function readStyleFile( $path, $flip ) {
$localPath = $this->getLocalPath( $path );
/**
- * @param $context ResourceLoaderContext
+ * @param ResourceLoaderContext $context
* @return array
*/
protected function getData( ResourceLoaderContext $context ) {
}
/**
- * @param $context ResourceLoaderContext
+ * @param ResourceLoaderContext $context
* @return string JavaScript code
*/
public function getScript( ResourceLoaderContext $context ) {
* load the files directly. See also getScriptURLsForDebug()
*
* @param ResourceLoaderContext $context
- * @return array array( mediaType => array( URL1, URL2, ... ), ... )
+ * @return array Array( mediaType => array( URL1, URL2, ... ), ... )
*/
public function getStyleURLsForDebug( ResourceLoaderContext $context ) {
$resourceLoader = $context->getResourceLoader();
return false;
}
- /** @var JSParser lazy-initialized; use self::javaScriptParser() */
+ /** @var JSParser Lazy-initialized; use self::javaScriptParser() */
private static $jsParser;
private static $parseCacheVersion = 1;
* This way we can reasonably reduce the amout of module registration
* data send to the client.
*
- * @param Array &$registryData Modules keyed by name with properties:
+ * @param array &$registryData Modules keyed by name with properties:
* - string 'version'
* - array 'dependencies'
* - string|null 'group'
* Checks for a change in the bitfield for a certain option and updates the
* provided array accordingly.
*
- * @param string $desc description to add to the array if the option was
+ * @param string $desc Description to add to the array if the option was
* enabled / disabled.
* @param int $field The bitmask describing the single option.
* @param int $diff The xor of the old and new bitfields.
dépôts / lhc / web / wiklou.git / commitdiff