r99604 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r99603‎ | r99604 | r99605 >
Date:00:06, 12 October 2011
Author:reedy
Status:ok
Tags:
Comment:
More documentation shizz
Modified paths:
  • /trunk/extensions/CodeReview/CodeReview.php (modified) (history)
  • /trunk/extensions/Collection/Collection.body.php (modified) (history)
  • /trunk/extensions/LocalisationUpdate/QuickArrayReader.php (modified) (history)
  • /trunk/extensions/SwiftMedia/SwiftMedia.body.php (modified) (history)

Diff [purge]

Index: trunk/extensions/Collection/Collection.body.php
@@ -805,6 +805,11 @@
806806 return $collection;
807807 }
808808
 809+ /**
 810+ * @param $title Title
 811+ * @param $forceOverwrite bool
 812+ * @return bool
 813+ */
809814 function saveCollection( $title, $forceOverwrite = false ) {
810815 global $wgUser;
811816
Index: trunk/extensions/CodeReview/CodeReview.php
@@ -377,6 +377,10 @@
378378 # Unit tests
379379 $wgHooks['UnitTestsList'][] = 'efCodeReviewUnitTests';
380380
 381+/**
 382+ * @param $files array
 383+ * @return bool
 384+ */
381385 function efCodeReviewUnitTests( &$files ) {
382386 $files[] = dirname( __FILE__ ) . '/tests/CodeReviewApiTest.php';
383387 $files[] = dirname( __FILE__ ) . '/tests/CodeReviewTest.php';
@@ -387,6 +391,10 @@
388392 # Add global JS vars
389393 $wgHooks['MakeGlobalVariablesScript'][] = 'efCodeReviewResourceLoaderGlobals';
390394
 395+/**
 396+ * @param $values array
 397+ * @return bool
 398+ */
391399 function efCodeReviewResourceLoaderGlobals( &$values ){
392400 # Bleugh, this is horrible
393401 global $wgTitle;
Index: trunk/extensions/LocalisationUpdate/QuickArrayReader.php
@@ -10,6 +10,9 @@
1111 class QuickArrayReader {
1212 var $vars = array();
1313
 14+ /**
 15+ * @param $string string
 16+ */
1417 function __construct( $string ) {
1518 $scalarTypes = array(
1619 T_LNUMBER => true,
@@ -118,6 +121,11 @@
119122 }
120123 }
121124
 125+ /**
 126+ * @param $got string
 127+ * @param $expected string
 128+ * @return Exception
 129+ */
122130 private function except( $got, $expected ) {
123131 if( is_array( $got ) ) {
124132 $got = token_name( $got[0] ) . " ('" . $got[1] . "')";
@@ -129,6 +137,9 @@
130138
131139 /**
132140 * Parse a scalar value in PHP
 141+ *
 142+ * @param $token string
 143+ *
133144 * @return mixed Parsed value
134145 */
135146 function parseScalar( $token ) {
@@ -161,6 +172,10 @@
162173 return $str;
163174 }
164175
 176+ /**
 177+ * @param $varname string
 178+ * @return null|string
 179+ */
165180 function getVar( $varname ) {
166181 if( isset( $this->vars[$varname] ) ) {
167182 return $this->vars[$varname];
Index: trunk/extensions/SwiftMedia/SwiftMedia.body.php
@@ -334,6 +334,7 @@
335335 * We KNOW the container should exist, so puke if it doesn't.
336336 *
337337 * @param $conn CF_Connection
 338+ * @param $cont string
338339 *
339340 * @return CF_Container
340341 */
@@ -583,7 +584,11 @@
584585 return $status;
585586 }
586587
587 -
 588+ /**
 589+ * @param $title
 590+ * @param $archiveName
 591+ * @return OldSwiftFile
 592+ */
588593 function newFromArchiveName( $title, $archiveName ) {
589594 return OldSwiftFile::newFromArchiveName( $title, $this, $archiveName );
590595 }
@@ -612,7 +617,7 @@
613618 list ( $cont, $rel ) = $rvu;
614619 $container = $this->get_container( $conn, $cont );
615620 try {
616 - $obj = $container->get_object( $rel );
 621+ $container->get_object( $rel );
617622 $result[$key] = true;
618623 } catch ( NoSuchObjectException $e ) {
619624 $result[$key] = false;
@@ -622,7 +627,6 @@
623628 return $result;
624629 }
625630
626 -
627631 // FIXME: do we really need to reject empty titles?
628632 function newFile( $title, $time = false ) {
629633 if ( empty( $title ) ) {

Status & tagging log