r107889 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r107888‎ | r107889 | r107890 >
Date:15:36, 3 January 2012
Author:reedy
Status:ok (Comments)
Tags:
Comment:
Fixup some returns/return documentation
Modified paths:
  • /trunk/phase3/includes/filerepo/FileRepo.php (modified) (history)
  • /trunk/phase3/includes/specials/SpecialBlock.php (modified) (history)
  • /trunk/phase3/includes/upload/UploadFromChunks.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/specials/SpecialBlock.php
@@ -334,7 +334,7 @@
335335
336336 /**
337337 * Add footer elements to the form
338 - * @return void
 338+ * @return string
339339 */
340340 protected function postText(){
341341 # Link to the user's contributions, if applicable
Index: trunk/phase3/includes/upload/UploadFromChunks.php
@@ -82,7 +82,7 @@
8383
8484 /**
8585 * Append the final chunk and ready file for parent::performUpload()
86 - * @return void
 86+ * @return FileRepoStatus
8787 */
8888 public function concatenateChunks() {
8989 wfDebug( __METHOD__ . " concatenate {$this->mChunkIndex} chunks:" .
Index: trunk/phase3/includes/filerepo/FileRepo.php
@@ -1223,10 +1223,9 @@
12241224 * May use either the database or the filesystem.
12251225 *
12261226 * @param $callback Array|string
1227 - * @return void
12281227 */
12291228 public function enumFiles( $callback ) {
1230 - return $this->enumFilesInStorage( $callback );
 1229+ $this->enumFilesInStorage( $callback );
12311230 }
12321231
12331232 /**
@@ -1234,7 +1233,6 @@
12351234 * May use either the database or the filesystem.
12361235 *
12371236 * @param $callback Array|string
1238 - * @return void
12391237 */
12401238 protected function enumFilesInStorage( $callback ) {
12411239 $publicRoot = $this->getZonePath( 'public' );

Comments

#Comment by Hashar (talk | contribs)   15:57, 3 January 2012

I would keep the "@return void", else you might expect someone forgot to document the return value :)

Status & tagging log