Fix broken @return documentation
authorThiemo Mättig <thiemo.maettig@wikimedia.de>
Sat, 24 May 2014 20:06:01 +0000 (22:06 +0200)
committerThiemo Mättig <thiemo.maettig@wikimedia.de>
Sat, 24 May 2014 20:06:01 +0000 (22:06 +0200)
I found one of these in Wikibase and run a global search.

Change-Id: I76c1519a47d7222f136272c59ea454b650808a86

includes/EditPage.php
includes/WebRequest.php
includes/api/ApiMain.php
includes/utils/ZipDirectoryReader.php

index 7be6274..e6186c6 100644 (file)
@@ -1254,7 +1254,7 @@ class EditPage {
         * @param array|bool $resultDetails
         *
         * @throws ErrorPageError
-        * return bool false, if output is done, true if rest of the form should be displayed
+        * @return bool false, if output is done, true if rest of the form should be displayed
         */
        private function handleStatus( Status $status, $resultDetails ) {
                global $wgUser, $wgOut;
index 391b49e..ecc2372 100644 (file)
@@ -489,7 +489,7 @@ class WebRequest {
         * @param float $default
         * @return float
         */
-       public function getFloat( $name, $default = 0 ) {
+       public function getFloat( $name, $default = 0.0 ) {
                return floatval( $this->getVal( $name, $default ) );
        }
 
index ccf91dd..df56735 100644 (file)
@@ -957,7 +957,7 @@ class ApiMain extends ApiBase {
        /**
         * Encode a value in a format suitable for a space-separated log line.
         * @param string $s
-        * return string
+        * @return string
         */
        protected function encodeRequestLogValue( $s ) {
                static $table;
index 1419bbb..6be186f 100644 (file)
@@ -546,6 +546,9 @@ class ZipDirectoryReader {
         * If there are not enough bytes in the file to satisfy the request, the
         * return value will be truncated. If a request is made for a segment beyond
         * the end of the file, an empty string will be returned.
+        *
+        * @param int $segIndex
+        *
         * @return string
         */
        function getSegment( $segIndex ) {