added doc

diff --git a/api/v3/Relationship.php b/api/v3/Relationship.php
index fcaed329c45e7df284db1622ed6649b6b83b65ee..a5845090e867c0e88a6b753b9e9566b4633cad14 100644 (file)
--- a/api/v3/Relationship.php
+++ b/api/v3/Relationship.php
@@ -147,6 +147,15 @@ function _civicrm_api3_handle_relationship_type(&$params) {
   }
 }
 
+/**
+ * Hack to ensure inherited membership got created/deleted on
+ * relationship add/delete respectively.
+ *
+ * @param array $params
+ *   Array per getfields metadata.
+ *
+ * @return array
+ */
 function civicrm_api3_relationship_setvalue($params) {
   require_once 'api/v3/Generic/Setvalue.php';
   $result = civicrm_api3_generic_setValue(array("entity" => 'Relationship', 'params' => $params));