From b6d74c6de1f15a81e10886fc5f8240f0306d8c1c Mon Sep 17 00:00:00 2001
From: Antoine Musso <hashar@users.mediawiki.org>
Date: Fri, 1 Oct 2004 03:10:10 +0000
Subject: [PATCH] comments

---
 includes/HTMLForm.php | 47 +++++++++++++++++++++++++++++++++++++------
 1 file changed, 41 insertions(+), 6 deletions(-)

diff --git a/includes/HTMLForm.php b/includes/HTMLForm.php
index 0512043af6..04d553f91b 100644
--- a/includes/HTMLForm.php
+++ b/includes/HTMLForm.php
@@ -1,4 +1,5 @@
 <?php
+/** */
 
 /**
  * Class to build various forms
@@ -7,12 +8,23 @@ class HTMLForm {
 	/** name of our form. Used as prefix for labels */
 	var $mName;
 
-	/* private */ function fieldset( $name, $content ) {
+	/**
+	 * @access private
+	 * @param string $name Name of the fieldset.
+	 * @param string $content HTML content to put in.
+	 * @return string HTML fieldset
+	 */
+	function fieldset( $name, $content ) {
 		return "<fieldset><legend>".wfMsg($this->mName.'-'.$name)."</legend>\n" .
 			$content . "\n</fieldset>\n";
 	}
 
-	/* private */ function checkbox( $varname, $checked=false ) {
+	/*
+	 * @access private
+	 * @param string $varname Name of the checkbox.
+	 * @param boolean $checked Set true to check the box (default False).
+	 */
+	function checkbox( $varname, $checked=false ) {
 		$checked = isset( $GLOBALS[$varname] ) && $GLOBALS[$varname] ;
 		return "<div><input type='checkbox' value=\"1\" id=\"{$varname}\" name=\"wpOp{$varname}\"" .
 			( $checked ? ' checked="checked"' : '' ) .
@@ -20,12 +32,24 @@ class HTMLForm {
 			"</label></div>\n";
 	}
 
-	/* private */ function textbox( $varname, $value='', $size=20 ) {
+	/* 
+	 * @access private
+	 * @param string $varname Name of the textbox.
+	 * @param string $value Optional value (default empty)
+	 * @param integer $size Optional size of the textbox (default 20)
+	 */
+	function textbox( $varname, $value='', $size=20 ) {
 		$value = isset( $GLOBALS[$varname] ) ? $GLOBALS[$varname] : $value;
 		return "<div><label>". wfMsg( $this->mName.'-'.$varname ) .
 			"<input type='text' name=\"wpOp{$varname}\" value=\"{$value}\" size=\"{$size}\" /></label></div>\n";
 	}
-	/* private */ function radiobox( $varname, $fields ) {
+
+	/* 
+	 * @access private
+	 * @param string $varname Name of the radiobox.
+	 * @param array $fields Various fields.
+	 */
+	function radiobox( $varname, $fields ) {
 		foreach ( $fields as $value => $checked ) {
 			$s .= "<div><label><input type='radio' name=\"wpOp{$varname}\" value=\"{$value}\"" .
 				( $checked ? ' checked="checked"' : '' ) . " />" . wfMsg( $this->mName.'-'.$varname.'-'.$value ) .
@@ -34,13 +58,24 @@ class HTMLForm {
 		return $this->fieldset( $this->mName.'-'.$varname, $s );
 	}
 	
-	/* private */ function textareabox ( $varname, $value='', $size=20 ) {
+	/* 
+	 * @access private
+	 * @param string $varname Name of the textareabox.
+	 * @param string $value Optional value (default empty)
+	 * @param integer $size Optional size of the textarea (default 20)
+	 */
+	function textareabox ( $varname, $value='', $size=20 ) {
 		$value = isset( $GLOBALS[$varname] ) ? $GLOBALS[$varname] : $value;
 		return '<div><label>'.wfMsg( $this->mName.'-'.$varname ).
 		       "<textarea name=\"wpOp{$varname}\" rows=\"5\" cols=\"{$size}\">$value</textarea>\n";
 	}
 
-	/* private */ function arraybox( $varname , $size=20 ) {
+	/* 
+	 * @access private
+	 * @param string $varname Name of the arraybox.
+	 * @param integer $size Optional size of the textarea (default 20)
+	 */
+	function arraybox( $varname , $size=20 ) {
 		$s = '';
 		if ( isset( $GLOBALS[$varname] ) && is_array( $GLOBALS[$varname] ) ) {
 			foreach ( $GLOBALS[$varname] as $index=>$element ) {
-- 
2.20.1