Merge remote-tracking branch 'upstream/4.5' into 4.5-4.6-2015-04-13-16-08-08

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

diff --git a/tests/templates/documentFunction.tpl b/tests/templates/documentFunction.tpl
index f1c9a1b6a6ca287d78c24e6082530ff0e74e4baf..43293eeda32672b03f64a421c05c0e8b741834c1 100644 (file)
--- a/tests/templates/documentFunction.tpl
+++ b/tests/templates/documentFunction.tpl
@@ -1,9 +1,18 @@
 {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
+ * {$result.deprecated}
+{if !$description}
+ *
+{/if}
+{/if}
 {if $description}
- * {$description}
+{foreach from=$description item='line'}
+ * {$line}
+{/foreach}
  *
 {/if}
  * @return array
@@ -13,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.
@@ -43,12 +52,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/