From 1e3c1afcacac23f4f7d34657dce6ba462b7ed97e Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Thu, 29 Sep 2011 19:49:01 -0400
Subject: Fixes #3827 updated documentation on @return for elgg_get_entities*
 functions

---
 engine/lib/plugins.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'engine/lib/plugins.php')

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index fd85ed9f0..365ef6fdf 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -978,7 +978,7 @@ function elgg_unset_all_plugin_settings($plugin_id = null) {
  * 	plugin_user_setting_name_value_pairs_operator => NULL|STR The operator to use for combining
  *                                        (name = value) OPERATOR (name = value); default AND
  *
- * @return mixed
+ * @return mixed int if count is true, an array of entity objects, or false on failure
  */
 function elgg_get_entities_from_plugin_user_settings(array $options = array()) {
 	// if they're passing it don't bother
-- 
cgit v1.2.3