From 0c13f046fbd8685570e4bccb6ac43c6058d3f8ae Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <eileen@fuzion.co.nz>
Date: Thu, 15 Jan 2015 13:59:02 +1300
Subject: [PATCH] fix example tpl for code standards

---
 tests/templates/documentFunction.tpl | 62 ++++++++++++++++++----------
 1 file changed, 40 insertions(+), 22 deletions(-)

diff --git a/tests/templates/documentFunction.tpl b/tests/templates/documentFunction.tpl
index 217bb6ff27..2cb738bf5c 100644
--- a/tests/templates/documentFunction.tpl
+++ b/tests/templates/documentFunction.tpl
@@ -1,41 +1,59 @@
 {literal}<?php{/literal}
 /**
- * Test Generated example of using {$fnPrefix} {$action} API
- *{if $description} {$description}{/if}
+ * @file
+ * Test Generated API Example.
+ * See bottom of this file for more detail.
+ */
+
+/**
+ * Test Generated example of using {$fnPrefix} {$action} API.
+ *
+{if $description}
+ * {$description}
+{/if}
  *
+ * @return array
+ *   API result array
  */
-function {$function}_example(){literal}{{/literal}
-$params = {$params|@print_array};
+function {$function}_example() {literal}{{/literal}
+  $params = {$params|@print_array};
 {literal}
-try{{/literal}
-  $result = civicrm_api3('{$fnPrefix}', '{$action}', $params);
-{literal}}
-catch (CiviCRM_API3_Exception $e) {
-  // handle error here
-  $errorMessage = $e->getMessage();
-  $errorCode = $e->getErrorCode();
-  $errorData = $e->getExtraParams();
-  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
-}{/literal}
+  try{{/literal}
+    $result = civicrm_api3('{$fnPrefix}', '{$action}', $params);
+{literal}  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'error' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }{/literal}
 
-return $result;
+  return $result;
 {literal}}{/literal}
 
 /**
- * Function returns array of result expected from previous function
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
  */
-function {$function}_expectedresult(){literal}{{/literal}
+function {$function}_expectedresult() {literal}{{/literal}
 
   $expectedResult = {$result|@print_array};
 
   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
+/**
+* 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}
 *
 * You can see the outcome of the API tests at
-- 
2.25.1