Merge pull request #8616 from totten/coldrunKacper-ignore-components-in-disabled...

[civicrm-core.git] / tests / templates / documentFunction.tpl

diff --git a/tests/templates/documentFunction.tpl b/tests/templates/documentFunction.tpl
index 36740310e910556b404d940cb905b976e05e49a0..5a40ea76e7e3f74f5e70a10b6eb60441f65f3e04 100644 (file)
--- a/tests/templates/documentFunction.tpl
+++ b/tests/templates/documentFunction.tpl
@@ -1,6 +1,6 @@
 {literal}<?php{/literal}
 /**
- * Test Generated example of using {$fnPrefix} {$action} API.
+ * Test Generated example demonstrating the {$entity}.{$action} API.
  *
 {if !empty($result.deprecated) && is_string($result.deprecated)}
  * @deprecated
@@ -10,7 +10,9 @@
 {/if}
 {/if}
 {if $description}
- * {$description}
+{foreach from=$description item='line'}
+ * {$line}
+{/foreach}
  *
 {/if}
  * @return array
@@ -20,7 +22,7 @@ function {$function}_example() {literal}{{/literal}
   $params = {$params|@print_array};
 {literal}
   try{{/literal}
-    $result = civicrm_api3('{$fnPrefix}', '{$action}', $params);
+    $result = civicrm_api3('{$entity}', '{$action}', $params);
 {literal}  }
   catch (CiviCRM_API3_Exception $e) {
     // Handle error here.
@@ -28,7 +30,8 @@ function {$function}_example() {literal}{{/literal}
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -50,12 +53,11 @@ function {$function}_expectedresult() {literal}{{/literal}
   return $expectedResult;
 {literal}}{/literal}
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* {$testfunction}
-* and can be found in
-* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/{$filename}
+* The test that created it is called "{$testFunction}"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/{$testFile}
 *
 * You can see the outcome of the API tests at
 * https://test.civicrm.org/job/CiviCRM-master-git/