Merge pull request #5901 from colemanw/CRM-16557
[civicrm-core.git] / api / v3 / Entity.php
index 2621d17f45443efb2f93070bb74319da4f65d89d..5113466851b471b80ed0c85ad1fa18538787b9c8 100644 (file)
@@ -3,7 +3,7 @@
 /**
  * Get list of deprecated entities.
  *
- * @deprecated api notice
+ * This is called by the api wrapper when returning the result of api.Entity.get.
  *
  * @param array $entities
  *
@@ -23,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) {
@@ -32,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) {
@@ -41,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) {