aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/relationships.php
diff options
context:
space:
mode:
authorcash <cash.costello@gmail.com>2011-11-01 21:17:21 -0400
committercash <cash.costello@gmail.com>2011-11-01 21:17:21 -0400
commit5b02eb29cb5b1e6efb27a9b8cb865bc86ef2eeea (patch)
tree5f609eb2a59794eed47871b1c5045a4ade79c24a /engine/lib/relationships.php
parent508fe03a44dec3a275c19fe2c63ab63fd04c0880 (diff)
downloadelgg-5b02eb29cb5b1e6efb27a9b8cb865bc86ef2eeea.tar.gz
elgg-5b02eb29cb5b1e6efb27a9b8cb865bc86ef2eeea.tar.bz2
standardized the elgg_get_entities* function @return documentation
Diffstat (limited to 'engine/lib/relationships.php')
-rw-r--r--engine/lib/relationships.php4
1 files changed, 2 insertions, 2 deletions
diff --git a/engine/lib/relationships.php b/engine/lib/relationships.php
index 1a5833732..929d3841d 100644
--- a/engine/lib/relationships.php
+++ b/engine/lib/relationships.php
@@ -250,7 +250,7 @@ function get_entity_relationships($guid, $inverse_relationship = FALSE) {
*
* inverse_relationship => BOOL Inverse the relationship
*
- * @return mixed if count, int. if not count, array or false if no entities. false also on errors.
+ * @return mixed If count, int. If not count, array. false on errors.
* @since 1.7.0
*/
function elgg_get_entities_from_relationship($options) {
@@ -372,7 +372,7 @@ function elgg_list_entities_from_relationship(array $options = array()) {
*
* @param array $options An options array compatible with
* elgg_get_entities_from_relationship()
- * @return mixed int if count is true, an array of entity objects, or false on failure
+ * @return mixed int If count, int. If not count, array. false on errors.
* @since 1.8.0
*/
function elgg_get_entities_from_relationship_count(array $options = array()) {