Whitespace fixes

Addition/tweak of documentation

diff --git a/includes/api/ApiFileRevert.php b/includes/api/ApiFileRevert.php
index bd20c05..c89d7ab 100644 (file)
--- a/includes/api/ApiFileRevert.php
+++ b/includes/api/ApiFileRevert.php
@@ -86,8 +86,6 @@ class ApiFileRevert extends ApiBase {
                if ( $permissionErrors ) {
                        $this->dieUsageMsg( $permissionErrors[0] );
                }
-               
-               
        }
 
        /**

diff --git a/includes/api/ApiParamInfo.php b/includes/api/ApiParamInfo.php
index c70fb37..1f8b383 100644 (file)
--- a/includes/api/ApiParamInfo.php
+++ b/includes/api/ApiParamInfo.php
@@ -85,7 +85,7 @@ class ApiParamInfo extends ApiBase {
        }
 
        /**
-        * @param  $obj ApiBase
+        * @param $obj ApiBase
         * @return ApiResult
         */
        function getClassInfo( $obj ) {

diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php
index 981bb87..3c1d0e7 100644 (file)
--- a/includes/api/ApiQuery.php
+++ b/includes/api/ApiQuery.php
@@ -278,6 +278,8 @@ class ApiQuery extends ApiBase {
         * Update a cache mode string, applying the cache mode of a new module to it.
         * The cache mode may increase in the level of privacy, but public modules
         * added to private data do not decrease the level of privacy.
+        *
+        * @return string
         */
        protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
                if ( $modCacheMode === 'anon-public-user-private' ) {

diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php
index 3812ba1..8d43479 100644 (file)
--- a/includes/api/ApiQueryBase.php
+++ b/includes/api/ApiQueryBase.php
@@ -54,6 +54,8 @@ abstract class ApiQueryBase extends ApiBase {
         *
         * Public caching will only be allowed if *all* the modules that supply
         * data for a given request return a cache mode of public.
+        *
+        * @return string
         */
        public function getCacheMode( $params ) {
                return 'private';
@@ -511,6 +513,9 @@ abstract class ApiQueryBase extends ApiBase {
                }
        }
 
+       /**
+        * @return array
+        */
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'invalidtitle', 'title' ),

diff --git a/includes/api/ApiResult.php b/includes/api/ApiResult.php
index 48cd5b1..5100973 100644 (file)
--- a/includes/api/ApiResult.php
+++ b/includes/api/ApiResult.php
@@ -249,6 +249,12 @@ class ApiResult extends ApiBase {
         * Path is an indexed array, each element specifying the branch at which to add the new value
         * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value
         * If $name is empty, the $value is added as a next list element data[] = $value
+        *
+        * @param $path
+        * @param $name string
+        * @param $value mixed
+        * @param $overwrite bool
+        *
         * @return bool True if $value fits in the result, false if not
         */
        public function addValue( $path, $name, $value, $overwrite = false ) {
@@ -330,6 +336,8 @@ class ApiResult extends ApiBase {
 
        /**
         * Callback function for cleanUpUTF8()
+        *
+        * @param $s string
         */
        private static function cleanUp_helper( &$s ) {
                if ( !is_string( $s ) ) {