a few random comment fixes

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

diff --git a/api/v3/CaseType.php b/api/v3/CaseType.php
index e0ec5eda0f69ae5f343889b881f96c767be9b32c..3d6508c7d958f1e9bef248c517e186f88c028273 100644 (file)
--- a/api/v3/CaseType.php
+++ b/api/v3/CaseType.php
@@ -1,7 +1,7 @@
 <?php
 /*
   +--------------------------------------------------------------------+
-  | CiviCRM version 4.5                                                |
+  | CiviCRM version 4.6                                                |
   +--------------------------------------------------------------------+
   | Copyright CiviCRM LLC (c) 2004-2014                                |
   +--------------------------------------------------------------------+
@@ -38,15 +38,17 @@
 /**
  * create or update case type
  *
- * @param  array $params   input parameters
+ * @param array $params
+ *   Input parameters.
  *
  * Allowed @params array keys are:
  * {@getfields case_type_create}
  *
  * @throws API_Exception
- * @return array API result array
+ * @return array
+ *   API result array
  *
- * @static void
+ * @static
  * @access public
  */
 function civicrm_api3_case_type_create($params) {
@@ -72,7 +74,8 @@ function civicrm_api3_case_type_create($params) {
  *
  * @param array $params
  *
- * @return array $caseTypes case types keyed by id
+ * @return array
+ *   case types keyed by id
  * @access public
  */
 function civicrm_api3_case_type_get($params) {
@@ -87,8 +90,9 @@ function civicrm_api3_case_type_get($params) {
 /**
  * format definition
  *
- * @param $caseTypes
+ * @param array $result
  * @return mixed
+ * @throws \CRM_Core_Exception
  */
 function _civicrm_api3_case_type_get_formatResult(&$result) {
   foreach ($result['values'] as $key => $caseType) {
@@ -96,7 +100,8 @@ function _civicrm_api3_case_type_get_formatResult(&$result) {
     $xml = CRM_Case_XMLRepository::singleton()->retrieve($caseTypeName);
     if ($xml) {
       $result['values'][$key]['definition'] = CRM_Case_BAO_CaseType::convertXmlToDefinition($xml);
-    } else {
+    }
+    else {
       $result['values'][$key]['definition'] = array();
     }
     $result['values'][$key]['is_forkable'] = CRM_Case_BAO_CaseType::isForkable($result['values'][$key]['id']);
@@ -108,9 +113,11 @@ function _civicrm_api3_case_type_get_formatResult(&$result) {
 /**
  * Function to delete case type
  *
- * @param array $params array including id of case_type to delete
+ * @param array $params
+ *   Array including id of case_type to delete.
 
- * @return array API result array
+ * @return array
+ *   API result array
  *
  * @access public
  *