From 64c0d2fb0aad5d99bb0bfd6d82854fce0f1c03bc Mon Sep 17 00:00:00 2001
From: Mateusz Uzdowski <mateusz@silverstripe.com>
Date: Fri, 1 Jun 2012 15:00:21 +1200
Subject: [PATCH] MINOR: add comments to FormField's RightTitle

---
 forms/FormField.php | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/forms/FormField.php b/forms/FormField.php
index e3bfb1fe3..023f6621c 100644
--- a/forms/FormField.php
+++ b/forms/FormField.php
@@ -40,7 +40,8 @@ class FormField extends RequestHandler {
 	public $dontEscape;
 	
 	/**
-	 * @var $rightTitle string Used in SmallFieldHolder() to force a right-aligned label.
+	 * @var $rightTitle string Used in SmallFieldHolder to force a right-aligned label, or in FieldHolder
+	 * to create contextual label.
 	 */
 	protected $rightTitle;
 	
@@ -224,10 +225,21 @@ class FormField extends RequestHandler {
 		return $this;
 	}
 
+	/**
+	 * Gets the contextual label than can be used for additional field description.
+	 * Can be shown to the right or under the field in question.
+	 *
+	 * @return string Contextual label text.
+	 */
 	function RightTitle() {
 		return $this->rightTitle;
 	}
 
+	/**
+	 * Sets the contextual label.
+	 *
+	 * @param $val string Text to set on the label.
+	 */
 	function setRightTitle($val) { 
 		$this->rightTitle = $val;
 		return $this;