X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fapi.php;h=2a857a1db1b8598b568cc1234ad15a044db6d2a9;hb=1c6c15e5e93c86f9f9861948926f3f8728d7cdae;hp=9ed9747dd0ca0b672fac76462c2f0f9ab911e6b2;hpb=eeeb9b4bb54071ad7562b2474854984bba527516;p=civicrm-core.git

diff --git a/api/api.php b/api/api.php
index 9ed9747dd0..2a857a1db1 100644
--- a/api/api.php
+++ b/api/api.php
@@ -125,7 +125,8 @@ function civicrm_api4(string $entity, string $action, array $params = [], $index
  *
  * @throws CiviCRM_API3_Exception
  *
- * @return array
+ * @return array|int
+ *   Dependant on the $action
  */
 function civicrm_api3(string $entity, string $action, array $params = []) {
   $params['version'] = 3;
@@ -179,7 +180,7 @@ function _civicrm_api3_api_getfields(&$apiRequest) {
  * 'format.is_success' => 1
  * will result in a boolean success /fail being returned if that is what you need.
  *
- * @param $result
+ * @param mixed $result
  *
  * @return bool
  *   true if error, false otherwise