getfields api - ensure 'name' property is set for every field

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

diff --git a/api/v3/Entity.php b/api/v3/Entity.php
index 204dd3ae01b4df23d8627681484cae0996292fff..ff3bb42511e40e6abb431a9c43c02a74c75a0565 100644 (file)
--- a/api/v3/Entity.php
+++ b/api/v3/Entity.php
@@ -1,9 +1,14 @@
 <?php
 
 /**
+ * Get list of deprecated entities.
+ *
  * @deprecated api notice
- * @param array entities
- * @return array of deprecated api entities
+ *
+ * @param array $entities
+ *
+ * @return array
+ *   Array of deprecated api entities
  */
 function _civicrm_api3_entity_deprecation($entities) {
   $deprecated = array();
@@ -18,25 +23,42 @@ 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
   // without putting an exception in for entity
   return civicrm_api3_create_success(array());
 }
-