From 338bd78e6613a119b0723bd2657393e1eed83ae7 Mon Sep 17 00:00:00 2001
From: jackbravo <jackbravo@625475ce-881a-0410-a577-b389adb331d8>
Date: Fri, 30 Nov 2007 23:49:46 +0000
Subject: [PATCH] Added a description to the Doctrine_Record::cleanData()
 method

---
 lib/Doctrine/Record.php | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lib/Doctrine/Record.php b/lib/Doctrine/Record.php
index 7d17d2352..209820df4 100644
--- a/lib/Doctrine/Record.php
+++ b/lib/Doctrine/Record.php
@@ -424,10 +424,11 @@ abstract class Doctrine_Record extends Doctrine_Record_Abstract implements Count
 
     /**
      * cleanData
+     * leaves the $data array only with values whose key is a field inside this
+     * record and returns the values that where removed from $data.
      *
      * @param array $data       data array to be cleaned
-     * @return integer
-     * @todo Better description. What exactly does this "cleaning" involve?
+     * @return array $tmp       values cleaned from data
      */
     public function cleanData(&$data)
     {