r51285 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r51284‎ | r51285 | r51286 >
Date:14:32, 1 June 2009
Author:ialex
Status:ok
Tags:
Comment:
Fix some doxygen warnings
Modified paths:
  • /trunk/phase3/includes/specials/SpecialRevisiondelete.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/specials/SpecialRevisiondelete.php
@@ -366,8 +366,8 @@
367367 }
368368
369369 /**
370 - * @param int $bitfields, aggregate bitfield of all the bitfields
371 - * @returns string HTML
 370+ * @param $bitfields Interger: aggregate bitfield of all the bitfields
 371+ * @return String: HTML
372372 */
373373 protected function buildCheckBoxes( $bitfields ) {
374374 $html = '';
@@ -384,7 +384,7 @@
385385
386386 /**
387387 * UI entry point for form submission.
388 - * @param WebRequest $request
 388+ * @param $request WebRequest
389389 */
390390 protected function submit( $request ) {
391391 global $wgUser, $wgOut;
@@ -434,8 +434,8 @@
435435
436436 /**
437437 * Put together a rev_deleted bitfield from the submitted checkboxes
438 - * @param WebRequest $request
439 - * @return int
 438+ * @param $request WebRequest
 439+ * @return Integer
440440 */
441441 protected function extractBitfield( $request ) {
442442 $bitfield = 0;
@@ -472,11 +472,11 @@
473473 * Checks for a change in the bitfield for a certain option and updates the
474474 * provided array accordingly.
475475 *
476 - * @param String $desc Description to add to the array if the option was
 476+ * @param $desc String: description to add to the array if the option was
477477 * enabled / disabled.
478 - * @param int $field The bitmask describing the single option.
479 - * @param int $diff The xor of the old and new bitfields.
480 - * @param array $arr The array to update.
 478+ * @param $field Integer: the bitmask describing the single option.
 479+ * @param $diff Integer: The xor of the old and new bitfields.
 480+ * @param $arr Array: The array to update.
481481 */
482482 protected static function checkItem( $desc, $field, $diff, $new, &$arr ) {
483483 if( $diff & $field ) {
@@ -492,8 +492,8 @@
493493 * a single string, which can be one of "applied restrictions to sysops",
494494 * "removed restrictions from sysops", or null.
495495 *
496 - * @param int $n The new bitfield.
497 - * @param int $o The old bitfield.
 496+ * @param $n Integer: the new bitfield.
 497+ * @param $o Integer: the old bitfield.
498498 * @return An array as described above.
499499 */
500500 protected static function getChanges( $n, $o ) {
@@ -521,10 +521,10 @@
522522 * message will be of the form "[hid {content, edit summary, username}];
523523 * [unhid {...}][applied restrictions to sysops] for $count revisions: $comment".
524524 *
525 - * @param int $count The number of effected revisions.
526 - * @param int $nbitfield The new bitfield for the revision.
527 - * @param int $obitfield The old bitfield for the revision.
528 - * @param bool $isForLog
 525+ * @param $count Integer: The number of effected revisions.
 526+ * @param $nbitfield Integer: The new bitfield for the revision.
 527+ * @param $obitfield Integer: The old bitfield for the revision.
 528+ * @param $isForLog Boolean
529529 */
530530 public static function getLogMessage( $count, $nbitfield, $obitfield, $isForLog = false ) {
531531 global $wgLang;

Status & tagging log