Skip to content
This repository
Browse code

MINOR: add comments to FormField's RightTitle

  • Loading branch information...
commit 64c0d2fb0aad5d99bb0bfd6d82854fce0f1c03bc 1 parent 5462cda
Mateusz U authored June 01, 2012

Showing 1 changed file with 13 additions and 1 deletion. Show diff stats Hide diff stats

  1. 14  forms/FormField.php
14  forms/FormField.php
@@ -40,7 +40,8 @@ class FormField extends RequestHandler {
40 40
 	public $dontEscape;
41 41
 	
42 42
 	/**
43  
-	 * @var $rightTitle string Used in SmallFieldHolder() to force a right-aligned label.
  43
+	 * @var $rightTitle string Used in SmallFieldHolder to force a right-aligned label, or in FieldHolder
  44
+	 * to create contextual label.
44 45
 	 */
45 46
 	protected $rightTitle;
46 47
 	
@@ -224,10 +225,21 @@ function setTitle($val) {
224 225
 		return $this;
225 226
 	}
226 227
 
  228
+	/**
  229
+	 * Gets the contextual label than can be used for additional field description.
  230
+	 * Can be shown to the right or under the field in question.
  231
+	 *
  232
+	 * @return string Contextual label text.
  233
+	 */
227 234
 	function RightTitle() {
228 235
 		return $this->rightTitle;
229 236
 	}
230 237
 
  238
+	/**
  239
+	 * Sets the contextual label.
  240
+	 *
  241
+	 * @param $val string Text to set on the label.
  242
+	 */
231 243
 	function setRightTitle($val) { 
232 244
 		$this->rightTitle = $val;
233 245
 		return $this;

0 notes on commit 64c0d2f

Please sign in to comment.
Something went wrong with that request. Please try again.