Merge pull request #5901 from colemanw/CRM-16557

[civicrm-core.git] / api / v3 / Entity.php

diff --git a/api/v3/Entity.php b/api/v3/Entity.php
index cfc64b59942ab2f812c440040242685af4f34540..5113466851b471b80ed0c85ad1fa18538787b9c8 100644 (file)
--- a/api/v3/Entity.php
+++ b/api/v3/Entity.php
@@ -1,10 +1,14 @@
 <?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
- *   of deprecated api entities
+ *   Array of deprecated api entities
  */
 function _civicrm_api3_entity_deprecation($entities) {
   $deprecated = array();
@@ -19,21 +23,39 @@ 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) {
   return civicrm_api3_create_error("API (Entity, Create) does not exist Creating a new entity means modifying the source code of civiCRM.");
 }
 
 /**
- *  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) {
   return civicrm_api3_create_error("API (Entity, Delete) does not exist Deleting an entity means modifying the source code of civiCRM.");
 }
 
 /**
- *  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) {
   // we return an empty array so it makes it easier to write generic getdefaults / required tests