r75598 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r75597‎ | r75598 | r75599 >
Date:23:56, 27 October 2010
Author:reedy
Status:ok
Tags:
Comment:
More function parameter commenting
Modified paths:
  • /trunk/phase3/includes/GlobalFunctions.php (modified) (history)
  • /trunk/phase3/includes/Xml.php (modified) (history)

Diff [purge]

Index: trunk/phase3/includes/Xml.php
@@ -102,7 +102,7 @@
103103 *
104104 * @param $element String element name
105105 * @param $attribs array of attributes
106 - * @param $contents content of the element
 106+ * @param $contents String content of the element
107107 * @return string
108108 */
109109 public static function tags( $element, $attribs = null, $contents ) {
@@ -248,8 +248,8 @@
249249
250250 /**
251251 * Shortcut to make a span element
252 - * @param $text content of the element, will be escaped
253 - * @param $class class name of the span element
 252+ * @param $text String content of the element, will be escaped
 253+ * @param $class String class name of the span element
254254 * @param $attribs other attributes
255255 * @return string
256256 */
@@ -271,7 +271,7 @@
272272
273273 /**
274274 * Convenience function to build an HTML text input field
275 - * @param $name value of the name attribute
 275+ * @param $name String value of the name attribute
276276 * @param $size value of the size attribute
277277 * @param $value value of the value attribute
278278 * @param $attribs other attributes
@@ -313,9 +313,9 @@
314314
315315 /**
316316 * Convenience function to build an HTML checkbox
317 - * @param $name value of the name attribute
318 - * @param $checked Whether the checkbox is checked or not
319 - * @param $attribs other attributes
 317+ * @param $name String value of the name attribute
 318+ * @param $checked Bool Whether the checkbox is checked or not
 319+ * @param $attribs Array other attributes
320320 * @return string HTML
321321 */
322322 public static function check( $name, $checked=false, $attribs=array() ) {
@@ -673,8 +673,8 @@
674674 /**
675675 * Generate a form (without the opening form element).
676676 * Output optionally includes a submit button.
677 - * @param $fields Associative array, key is message corresponding to a description for the field (colon is in the message), value is appropriate input.
678 - * @param $submitLabel A message containing a label for the submit button.
 677+ * @param $fields Array Associative array, key is message corresponding to a description for the field (colon is in the message), value is appropriate input.
 678+ * @param $submitLabel String A message containing a label for the submit button.
679679 * @return string HTML form.
680680 */
681681 public static function buildForm( $fields, $submitLabel = null ) {
Index: trunk/phase3/includes/GlobalFunctions.php
@@ -2454,7 +2454,7 @@
24552455 /**
24562456 * Execute a shell command, with time and memory limits mirrored from the PHP
24572457 * configuration if supported.
2458 - * @param $cmd Command line, properly escaped for shell.
 2458+ * @param $cmd String Command line, properly escaped for shell.
24592459 * @param &$retval optional, will receive the program's exit code.
24602460 * (non-zero is usually failure)
24612461 * @param $environ Array optional environment variables which should be

Status & tagging log