From ff4c82039d2359f09361cd08d0f6efe70dc9103f Mon Sep 17 00:00:00 2001
From: Sean Harvey <sean@silverstripe.com>
Date: Fri, 23 Mar 2012 10:50:17 +1300
Subject: [PATCH] MINOR Class documentation for GridFieldDeleteAction

---
 forms/gridfield/GridFieldDeleteAction.php | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/forms/gridfield/GridFieldDeleteAction.php b/forms/gridfield/GridFieldDeleteAction.php
index a84b21a66..87f0d8c82 100644
--- a/forms/gridfield/GridFieldDeleteAction.php
+++ b/forms/gridfield/GridFieldDeleteAction.php
@@ -1,11 +1,20 @@
 <?php
 /**
- * This class is an GridField Component that add Delete action for Objects in the GridField.
- * See {@link GridFieldRemoveButton} for detaching an item from the current relationship instead.
+ * This class is an GridField component that adds a delete action for objects in a {@link GridField}.
+ *
+ * This will also supports unlinking a relation instead of deleting the object. Use the {@link $removeRelation}
+ * property set in the constructor.
+ *
+ * <code>
+ * $action = new GridFieldDeleteAction(); // delete objects permanently
+ * $action = new GridFieldDeleteAction(true); // removes the relation to object, instead of deleting
+ * </code>
+ *
+ * @package sapphire
+ * @subpackage gridfield
  */
 class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_ActionProvider {
 	
-	
 	/**
 	 * If this is set to true, this actionprovider will remove the object from the list, instead of 
 	 * deleting. In the case of a has one, has many or many many list it will uncouple the item from 
@@ -125,4 +134,4 @@ class GridFieldDeleteAction implements GridField_ColumnProvider, GridField_Actio
 			$gridField->getList()->remove($item);
 		} 
 	}
-}
\ No newline at end of file
+}