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 5c2172ae7c06f151485a4df569ab39b75d008c2a..5b4132db46b5ab8791de7f94e0f6983745702a09 100644 (file)
--- 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.