INFRA-132 - Docblock formatting fixes

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

diff --git a/api/v3/WordReplacement.php b/api/v3/WordReplacement.php
index 7a1e2877c98c1b0affb66dab5630f05ebd8f7c9f..72e6f82feaac03313a277a88c7dadb2a9377cbb7 100644 (file)
--- a/api/v3/WordReplacement.php
+++ b/api/v3/WordReplacement.php
@@ -1,10 +1,9 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -32,7 +31,7 @@
  * @package CiviCRM_APIv3
  * @subpackage API_WordReplacement
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: Domain.php 30171 2010-10-14 09:11:27Z mover $
  *
  */
@@ -40,12 +39,12 @@
 /**
  * Get CiviCRM Word Replacement details
  * {@getfields word_replacement_create}
- * 
+ *
  */
 function civicrm_api3_word_replacement_get($params) {
   $bao = new CRM_Core_BAO_WordReplacement();
-  _civicrm_api3_dao_set_filter($bao, $params, true, 'WordReplacement');
-  $wordReplacements = _civicrm_api3_dao_to_array($bao, $params, true,'WordReplacement');
+  _civicrm_api3_dao_set_filter($bao, $params, TRUE, 'WordReplacement');
+  $wordReplacements = _civicrm_api3_dao_to_array($bao, $params, TRUE, 'WordReplacement');
 
   return civicrm_api3_create_success($wordReplacements, $params, 'word_replacement', 'get', $bao);
 }
@@ -57,7 +56,7 @@ function civicrm_api3_word_replacement_get($params) {
  * @param array $params
  *
  * @return array
- * 
+ *
  * {@getfields word_replacement_create}
  */
 function civicrm_api3_word_replacement_create($params) {
@@ -68,7 +67,8 @@ function civicrm_api3_word_replacement_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_word_replacement_create_spec(&$params) {
   unset($params['version']);
@@ -78,14 +78,15 @@ function _civicrm_api3_word_replacement_create_spec(&$params) {
  * delete an existing word_replacement
  *
  *
- * @param array $params  (reference) array containing id of the word_replacement
- *                       to be deleted
+ * @param array $params
+ *   Array containing id of the word_replacement.
+ *   to be deleted
  *
- * @return array  (referance) returns flag true if successfull, error
- *                message otherwise
+ * @return array
+ *   api result array
  *
  * @access public
  */
 function civicrm_api3_word_replacement_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
-}
\ No newline at end of file
+}