Merge pull request #6378 from johanv/CRM-15991-permission_delete_relationship
[civicrm-core.git] / api / v3 / Entity.php
index 10234aababcb9289e32e3c2db4af2ff93179ccd3..5113466851b471b80ed0c85ad1fa18538787b9c8 100644 (file)
@@ -1,8 +1,12 @@
 <?php
 
 /**
- * @deprecated api notice
- * @param array entities
+ * Get list of deprecated entities.
+ *
+ * This is called by the api wrapper when returning the result of api.Entity.get.
+ *
+ * @param array $entities
+ *
  * @return array
  *   Array of deprecated api entities
  */
@@ -19,8 +23,12 @@ function _civicrm_api3_entity_deprecation($entities) {
 }
 
 /**
- *  Placeholder function. This should never be called, as it doesn't have any meaning
+ * Placeholder function.
+ *
+ * This should never be called, as it doesn't have any meaning.
+ *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_entity_create($params) {
@@ -28,8 +36,12 @@ function civicrm_api3_entity_create($params) {
 }
 
 /**
- *  Placeholder function. This should never be called, as it doesn't have any meaning
+ * Placeholder function.
+ *
+ * This should never be called, as it doesn't have any meaning.
+ *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_entity_delete($params) {
@@ -37,8 +49,12 @@ function civicrm_api3_entity_delete($params) {
 }
 
 /**
- *  Placeholder function. This should never be called, as it doesn't have any meaning
+ * Placeholder function.
+ *
+ * This should never be called, as it doesn't have any meaning.
+ *
  * @param array $params
+ *
  * @return array
  */
 function civicrm_api3_entity_getfields($params) {