From: brettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Tue, 8 Mar 2011 02:57:48 +0000 (+0000)
Subject: Added a bit more docs to ElggBatch.
X-Git-Url: https://gitweb.fluxo.info/?a=commitdiff_plain;h=1900eedee2f8d2fa729a01293238c2ad85fb4147;p=lorea%2Felgg.git

Added a bit more docs to ElggBatch.


git-svn-id: http://code.elgg.org/elgg/trunk@8625 36083f99-b078-4883-b0ff-0f9b5a30f544
---

diff --git a/engine/classes/ElggBatch.php b/engine/classes/ElggBatch.php
index 5c2172ae7..5b4132db4 100644
--- a/engine/classes/ElggBatch.php
+++ b/engine/classes/ElggBatch.php
@@ -11,6 +11,8 @@
  * can be a string, an array, or a closure.
  * {@link http://php.net/manual/en/language.pseudo-types.php}
  *
+ * The callback function must accepts 3 arguments: an entity, the getter used, and the options used.
+ *
  * Results from the callback are stored in callbackResult.
  * If the callback returns only booleans callbackResults will be the combined
  * result of all calls.