Fixed docs

- Use short form of boolean
- Use capital at begin of doc text

Change-Id: Ic5afacfa7298b1938d3b45ffd0cac5ce01f2f9db

diff --git a/includes/OutputPage.php b/includes/OutputPage.php
index 85d101f..87a0809 100644 (file)
--- a/includes/OutputPage.php
+++ b/includes/OutputPage.php
@@ -1971,7 +1971,7 @@ class OutputPage extends ContextSource {
         * Get the prevent-clickjacking flag
         *
         * @since 1.24
-        * @return boolean
+        * @return bool
         */
        public function getPreventClickjacking() {
                return $this->mPreventClickjacking;

diff --git a/includes/parser/ParserOutput.php b/includes/parser/ParserOutput.php
index 3de7505..22b127d 100644 (file)
--- a/includes/parser/ParserOutput.php
+++ b/includes/parser/ParserOutput.php
@@ -799,8 +799,8 @@ class ParserOutput extends CacheTime {
         * Get or set the prevent-clickjacking flag
         *
         * @since 1.24
-        * @param boolean|null $flag New flag value, or null to leave it unchanged
-        * @return boolean Old flag value
+        * @param bool|null $flag New flag value, or null to leave it unchanged
+        * @return bool Old flag value
         */
        public function preventClickjacking( $flag = null ) {
                return wfSetVar( $this->mPreventClickjacking, $flag );

diff --git a/includes/password/PasswordFactory.php b/includes/password/PasswordFactory.php
index 70b7656..3b4ebb1 100644 (file)
--- a/includes/password/PasswordFactory.php
+++ b/includes/password/PasswordFactory.php
@@ -98,8 +98,8 @@ final class PasswordFactory {
         * if a null hash is given.
         *
         * @param string|null $hash Existing hash or null for an invalid password
-        * @return Password object
-        * @throws PasswordError if hash is invalid or type is not recognized
+        * @return Password
+        * @throws PasswordError If hash is invalid or type is not recognized
         */
        public function newFromCiphertext( $hash ) {
                if ( $hash === null || $hash === false || $hash === '' ) {
@@ -122,8 +122,8 @@ final class PasswordFactory {
         * Make a new default password of the given type.
         *
         * @param string $type Existing type
-        * @return Password object
-        * @throws PasswordError if hash is invalid or type is not recognized
+        * @return Password
+        * @throws PasswordError If hash is invalid or type is not recognized
         */
        public function newFromType( $type ) {
                if ( !isset( $this->types[$type] ) ) {
@@ -143,7 +143,7 @@ final class PasswordFactory {
         *
         * @param string $password Plaintext password
         * @param Password|null $existing Optional existing hash to get options from
-        * @return Password object
+        * @return Password
         */
        public function newFromPlaintext( $password, Password $existing = null ) {
                if ( $existing === null ) {

diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php
index bcb3842..8da3c47 100644 (file)
--- a/includes/resourceloader/ResourceLoader.php
+++ b/includes/resourceloader/ResourceLoader.php
@@ -493,7 +493,7 @@ class ResourceLoader {
         * Return whether the definition of a module corresponds to a simple ResourceLoaderFileModule.
         *
         * @param string $name Module name
-        * @return boolean
+        * @return bool
         */
        protected function isFileModule( $name ) {
                if ( !isset( $this->moduleInfos[$name] ) ) {

diff --git a/includes/resourceloader/ResourceLoaderFileModule.php b/includes/resourceloader/ResourceLoaderFileModule.php
index edde9bc..c3a36e4 100644 (file)
--- a/includes/resourceloader/ResourceLoaderFileModule.php
+++ b/includes/resourceloader/ResourceLoaderFileModule.php
@@ -292,7 +292,7 @@ class ResourceLoaderFileModule extends ResourceLoaderModule {
         *     to $IP
         * @param string $remoteBasePath Path to use if not provided in module definition. Defaults
         *     to $wgScriptPath
-        * @return array array( localBasePath, remoteBasePath )
+        * @return array Array( localBasePath, remoteBasePath )
         */
        public static function extractBasePaths(
                $options = array(),