INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/Generic.php b/api/v3/Generic.php
index ee41baa8a80ccab305cf2cb86beb98fa14f4afc0..4de5a5db663b72c8df0ed491994f0d3f7e399fbb 100644 (file)
--- a/api/v3/Generic.php
+++ b/api/v3/Generic.php
@@ -12,12 +12,13 @@
  *
  * @param array $apiRequest
  *   Api request as an array. Keys are.
- *  - entity: string
- *  - action: string
- *  - version: string
- *  - function: callback (mixed)
- *  - params: array, varies
- * @return array API success object
+ *   - entity: string
+ *   - action: string
+ *   - version: string
+ *   - function: callback (mixed)
+ *   - params: array, varies
+ * @return array
+ *   API success object
  */
 function civicrm_api3_generic_getfields($apiRequest) {
   static $results = array();
@@ -55,6 +56,7 @@ function civicrm_api3_generic_getfields($apiRequest) {
     case 'getfields':
       $values = _civicrm_api_get_fields($entity, FALSE, $apiRequest['params']);
       return civicrm_api3_create_success($values, $apiRequest['params'], $entity, 'getfields');
+
     case 'create':
     case 'update':
     case 'replace':
@@ -148,7 +150,8 @@ function civicrm_api3_generic_getfields($apiRequest) {
  *   Api request as an array. Keys are.
  *
  * @throws API_Exception
- * @return integer count of results
+ * @return int
+ *   count of results
  */
 function civicrm_api3_generic_getcount($apiRequest) {
   $apiRequest['params']['options']['is_count'] = TRUE;
@@ -168,7 +171,8 @@ function civicrm_api3_generic_getcount($apiRequest) {
  * @param array $apiRequest
  *   Api request as an array. Keys are.
  *
- * @return integer count of results
+ * @return int
+ *   count of results
  */
 function civicrm_api3_generic_getsingle($apiRequest) {
   // so the first entity is always result['values'][0]
@@ -192,7 +196,8 @@ function civicrm_api3_generic_getsingle($apiRequest) {
  * @param array $apiRequest
  *   Api request as an array. Keys are.
  *
- * @return integer count of results
+ * @return int
+ *   count of results
  */
 function civicrm_api3_generic_getvalue($apiRequest) {
   $apiRequest['params']['sequential'] = 1;
@@ -232,7 +237,8 @@ function _civicrm_api3_generic_getrefcount_spec(&$params) {
  *   Api request as an array.
  *
  * @throws API_Exception
- * @return array API result (int 0 or 1)
+ * @return array
+ *   API result (int 0 or 1)
  */
 function civicrm_api3_generic_getrefcount($apiRequest) {
   $entityToClassMap = CRM_Core_DAO_AllCoreTables::daoToClass();
@@ -258,7 +264,8 @@ function civicrm_api3_generic_getrefcount($apiRequest) {
  * @param array $apiRequest
  *   Api request as an array. Keys are.
  *
- * @return integer count of results
+ * @return int
+ *   count of results
  */
 function civicrm_api3_generic_replace($apiRequest) {
   return _civicrm_api3_generic_replace($apiRequest['entity'], $apiRequest['params']);
@@ -270,7 +277,8 @@ function civicrm_api3_generic_replace($apiRequest) {
  * @param array $apiRequest
  *   Api request as an array.
  *
- * @return array of results
+ * @return array
+ *   Array of results
  */
 function civicrm_api3_generic_getoptions($apiRequest) {
   // Resolve aliases
@@ -308,7 +316,7 @@ function civicrm_api3_generic_getoptions($apiRequest) {
  *
  * @param array $metadata
  *   The array of metadata that will form the result of the getfields function.
- * @param $apiRequest
+ * @param array $apiRequest
  * @param string $fieldname
  *   Field currently being processed.
  * @param array $fieldSpec