Always use 'bool' instead of 'boolean' in Doxygen tags
authorRicordisamoa <ricordisamoa@openmailbox.org>
Thu, 24 Mar 2016 08:44:09 +0000 (09:44 +0100)
committerRicordisamoa <ricordisamoa@openmailbox.org>
Thu, 24 Mar 2016 08:44:09 +0000 (09:44 +0100)
Just like commit f86a5590aae7fbe6d9b8a3d129c7a04a11a27579

Change-Id: Ic9d08bca6524d6bb4baf5170c081ad0f3d738e28

16 files changed:
includes/MergeHistory.php
includes/TemplateParser.php
includes/Title.php
includes/api/ApiBase.php
includes/api/ApiMain.php
includes/api/ApiResult.php
includes/filerepo/FileRepo.php
includes/htmlform/VFormHTMLForm.php
includes/libs/MWMessagePack.php
includes/media/WebP.php
includes/poolcounter/PoolCounter.php
includes/resourceloader/ResourceLoaderRawFileModule.php
includes/site/HashSiteStore.php
includes/utils/BatchRowIterator.php
includes/utils/MWCryptHash.php
tests/phpunit/MediaWikiTestCase.php

index a92056d..441fe9e 100644 (file)
@@ -51,7 +51,7 @@ class MergeHistory {
        /** @var string SQL WHERE condition that selects source revisions to insert into destination */
        protected $timeWhere;
 
-       /** @var MWTimestamp|boolean Timestamp upto which history from the source will be merged */
+       /** @var MWTimestamp|bool Timestamp upto which history from the source will be merged */
        protected $timestampLimit;
 
        /** @var integer Number of revisions merged (for Special:MergeHistory success message) */
@@ -61,7 +61,7 @@ class MergeHistory {
         * MergeHistory constructor.
         * @param Title $source Page from which history will be merged
         * @param Title $dest Page to which history will be merged
-        * @param string|boolean $timestamp Timestamp up to which history from the source will be merged
+        * @param string|bool $timestamp Timestamp up to which history from the source will be merged
         */
        public function __construct( Title $source, Title $dest, $timestamp = false ) {
                // Save the parameters
index 6420dc7..20142a7 100644 (file)
@@ -38,7 +38,7 @@ class TemplateParser {
 
        /**
         * @param string $templateDir
-        * @param boolean $forceRecompile
+        * @param bool $forceRecompile
         */
        public function __construct( $templateDir = null, $forceRecompile = false ) {
                $this->templateDir = $templateDir ?: __DIR__ . '/templates';
index 262c6fa..8bafe26 100644 (file)
@@ -145,7 +145,7 @@ class Title implements LinkTarget {
        /** @var bool The (string) language code of the page's language and content code. */
        private $mPageLanguage = false;
 
-       /** @var string|boolean|null The page language code from the database, null if not saved in
+       /** @var string|bool|null The page language code from the database, null if not saved in
         * the database or false if not loaded, yet. */
        private $mDbPageLanguage = false;
 
@@ -4627,7 +4627,7 @@ class Title implements LinkTarget {
         * to true in LocalSettings.php, otherwise returns false. If there is no language saved in
         * the db, it will return NULL.
         *
-        * @return string|null|boolean
+        * @return string|null|bool
         */
        private function getDbPageLanguageCode() {
                global $wgPageLanguageUseDB;
index 7944167..1c20229 100644 (file)
@@ -437,7 +437,7 @@ abstract class ApiBase extends ContextSource {
         *    RFC 7232 § 2.2 for semantics.
         *  - etag: Return an entity-tag representing the state of all resources involved
         *    in the request. Quotes must be included. See RFC 7232 § 2.3 for semantics.
-        * @return string|boolean|null As described above, or null if no value is available.
+        * @return string|bool|null As described above, or null if no value is available.
         */
        public function getConditionalRequestData( $condition ) {
                return null;
index df3f516..63b79ac 100644 (file)
@@ -711,7 +711,7 @@ class ApiMain extends ApiBase {
 
        /**
         * Send caching headers
-        * @param boolean $isError Whether an error response is being output
+        * @param bool $isError Whether an error response is being output
         * @since 1.26 added $isError parameter
         */
        protected function sendCacheHeaders( $isError ) {
index 3436320..5d5c829 100644 (file)
@@ -1150,7 +1150,7 @@ class ApiResult implements ApiSerializable {
         * the API.
         *
         * @param array $vars
-        * @param boolean $forceHash
+        * @param bool $forceHash
         * @return array
         */
        public static function addMetadataToResultVars( $vars, $forceHash = true ) {
index 1565b49..15821ea 100644 (file)
@@ -1906,7 +1906,7 @@ class FileRepo {
 
        /**
         * Returns whether or not storage is SHA-1 based
-        * @return boolean
+        * @return bool
         */
        public function hasSha1Storage() {
                return $this->hasSha1Storage;
@@ -1914,7 +1914,7 @@ class FileRepo {
 
        /**
         * Returns whether or not repo supports having originals SHA-1s in the thumb URLs
-        * @return boolean
+        * @return bool
         */
        public function supportsSha1URLs() {
                return $this->supportsSha1URLs;
index f0f961e..c446615 100644 (file)
@@ -27,7 +27,7 @@
 class VFormHTMLForm extends HTMLForm {
        /**
         * Wrapper and its legend are never generated in VForm mode.
-        * @var boolean
+        * @var bool
         */
        protected $mWrapperLegend = false;
 
index cd9aad8..a9da366 100644 (file)
@@ -33,7 +33,7 @@
  * @file
  */
 class MWMessagePack {
-       /** @var boolean|null Whether current system is bigendian. **/
+       /** @var bool|null Whether current system is bigendian. **/
        public static $bigendian = null;
 
        /**
index 8fda751..6a01e87 100644 (file)
@@ -154,7 +154,7 @@ class WebPHandler extends BitmapHandler {
        /**
         * Decodes a lossy chunk header
         * @param string $header Header string
-        * @return boolean|array See WebPHandler::decodeHeader
+        * @return bool|array See WebPHandler::decodeHeader
         */
        protected static function decodeLossyChunkHeader( $header ) {
                // Bytes 0-3 are 'VP8 '
@@ -180,7 +180,7 @@ class WebPHandler extends BitmapHandler {
        /**
         * Decodes a lossless chunk header
         * @param string $header Header string
-        * @return boolean|array See WebPHandler::decodeHeader
+        * @return bool|array See WebPHandler::decodeHeader
         */
        public static function decodeLosslessChunkHeader( $header ) {
                // Bytes 0-3 are 'VP8L'
@@ -205,7 +205,7 @@ class WebPHandler extends BitmapHandler {
        /**
         * Decodes an extended chunk header
         * @param string $header Header string
-        * @return boolean|array See WebPHandler::decodeHeader
+        * @return bool|array See WebPHandler::decodeHeader
         */
        public static function decodeExtendedChunkHeader( $header ) {
                // Bytes 0-3 are 'VP8X'
index 1ec14aa..acdbd81 100644 (file)
@@ -71,11 +71,11 @@ abstract class PoolCounter {
        protected $timeout;
 
        /**
-        * @var boolean Whether the key is a "might wait" key
+        * @var bool Whether the key is a "might wait" key
         */
        private $isMightWaitKey;
        /**
-        * @var boolean Whether this process holds a "might wait" lock key
+        * @var bool Whether this process holds a "might wait" lock key
         */
        private static $acquiredMightWaitKey = 0;
 
index d9005fa..beab53e 100644 (file)
@@ -31,7 +31,7 @@ class ResourceLoaderRawFileModule extends ResourceLoaderFileModule {
        /**
         * Enable raw mode to omit mw.loader.state() call as mw.loader
         * does not yet exist when these modules execute.
-        * @var boolean
+        * @var bool
         */
        protected $raw = true;
 
index 0d0e448..198d331 100644 (file)
@@ -50,7 +50,7 @@ class HashSiteStore implements SiteStore {
         *
         * @param Site $site
         *
-        * @return boolean Success indicator
+        * @return bool Success indicator
         */
        public function saveSite( Site $site ) {
                $this->sites[$site->getGlobalId()] = $site;
@@ -65,7 +65,7 @@ class HashSiteStore implements SiteStore {
         *
         * @param Site[] $sites
         *
-        * @return boolean Success indicator
+        * @return bool Success indicator
         */
        public function saveSites( array $sites ) {
                foreach ( $sites as $site ) {
index 002fd06..3bd3a4c 100644 (file)
@@ -166,14 +166,14 @@ class BatchRowIterator implements RecursiveIterator {
        }
 
        /**
-        * @return boolean True when the iterator is in a valid state
+        * @return bool True when the iterator is in a valid state
         */
        public function valid() {
                return (bool)$this->current;
        }
 
        /**
-        * @return boolean True when this result set has rows
+        * @return bool True when this result set has rows
         */
        public function hasChildren() {
                return $this->current && count( $this->current );
index 75eaede..72c620e 100644 (file)
@@ -70,7 +70,7 @@ class MWCryptHash {
         * Return the byte-length output of the hash algorithm we are
         * using in self::hash and self::hmac.
         *
-        * @param boolean $raw True to return the length for binary data, false to
+        * @param bool $raw True to return the length for binary data, false to
         *   return for hex-encoded
         * @return int Number of bytes the hash outputs
         */
@@ -88,7 +88,7 @@ class MWCryptHash {
         * making use of the best hash algorithm that we have available.
         *
         * @param string $data
-        * @param boolean $raw True to return binary data, false to return it hex-encoded
+        * @param bool $raw True to return binary data, false to return it hex-encoded
         * @return string A hash of the data
         */
        public static function hash( $data, $raw = true ) {
@@ -101,7 +101,7 @@ class MWCryptHash {
         *
         * @param string $data
         * @param string $key
-        * @param boolean $raw True to return binary data, false to return it hex-encoded
+        * @param bool $raw True to return binary data, false to return it hex-encoded
         * @return string An hmac hash of the data + key
         */
        public static function hmac( $data, $key, $raw = true ) {
index dc69902..4d0e39c 100644 (file)
@@ -161,7 +161,7 @@ abstract class MediaWikiTestCase extends PHPUnit_Framework_TestCase {
        }
 
        /**
-        * @return boolean
+        * @return bool
         */
        private function oncePerClass() {
                // Remember current test class in the database connection,