r87699 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r87698‎ | r87699 | r87700 >
Date:21:47, 8 May 2011
Author:reedy
Status:ok
Tags:
Comment:
Whitespace fixes

Addition/tweak of documentation
Modified paths:
  • /trunk/phase3/includes/api/ApiFileRevert.php (modified) (history)
  • /trunk/phase3/includes/api/ApiParamInfo.php (modified) (history)
  • /trunk/phase3/includes/api/ApiQuery.php (modified) (history)
  • /trunk/phase3/includes/api/ApiQueryBase.php (modified) (history)
  • /trunk/phase3/includes/api/ApiResult.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/api/ApiFileRevert.php
@@ -86,8 +86,6 @@
8787 if ( $permissionErrors ) {
8888 $this->dieUsageMsg( $permissionErrors[0] );
8989 }
90 -
91 -
9290 }
9391
9492 /**
Index: trunk/phase3/includes/api/ApiQueryBase.php
@@ -54,6 +54,8 @@
5555 *
5656 * Public caching will only be allowed if *all* the modules that supply
5757 * data for a given request return a cache mode of public.
 58+ *
 59+ * @return string
5860 */
5961 public function getCacheMode( $params ) {
6062 return 'private';
@@ -511,6 +513,9 @@
512514 }
513515 }
514516
 517+ /**
 518+ * @return array
 519+ */
515520 public function getPossibleErrors() {
516521 return array_merge( parent::getPossibleErrors(), array(
517522 array( 'invalidtitle', 'title' ),
Index: trunk/phase3/includes/api/ApiResult.php
@@ -249,6 +249,12 @@
250250 * Path is an indexed array, each element specifying the branch at which to add the new value
251251 * Setting $path to array('a','b','c') is equivalent to data['a']['b']['c'] = $value
252252 * If $name is empty, the $value is added as a next list element data[] = $value
 253+ *
 254+ * @param $path
 255+ * @param $name string
 256+ * @param $value mixed
 257+ * @param $overwrite bool
 258+ *
253259 * @return bool True if $value fits in the result, false if not
254260 */
255261 public function addValue( $path, $name, $value, $overwrite = false ) {
@@ -330,6 +336,8 @@
331337
332338 /**
333339 * Callback function for cleanUpUTF8()
 340+ *
 341+ * @param $s string
334342 */
335343 private static function cleanUp_helper( &$s ) {
336344 if ( !is_string( $s ) ) {
Index: trunk/phase3/includes/api/ApiQuery.php
@@ -278,6 +278,8 @@
279279 * Update a cache mode string, applying the cache mode of a new module to it.
280280 * The cache mode may increase in the level of privacy, but public modules
281281 * added to private data do not decrease the level of privacy.
 282+ *
 283+ * @return string
282284 */
283285 protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
284286 if ( $modCacheMode === 'anon-public-user-private' ) {
Index: trunk/phase3/includes/api/ApiParamInfo.php
@@ -85,7 +85,7 @@
8686 }
8787
8888 /**
89 - * @param $obj ApiBase
 89+ * @param $obj ApiBase
9090 * @return ApiResult
9191 */
9292 function getClassInfo( $obj ) {

Status & tagging log