Merge pull request #4915 from eileenmcnaughton/minor-tidies

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

diff --git a/api/v3/GroupOrganization.php b/api/v3/GroupOrganization.php
index b683a9e3838d32b5f30dd65e4fec12675b2bcc1d..759371df7b08af6be0008f211b1c2680e4f81591 100644 (file)
--- a/api/v3/GroupOrganization.php
+++ b/api/v3/GroupOrganization.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_Group
  *
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $
  *
  */
@@ -44,11 +43,13 @@
  * If no status mentioned in params, by default 'added' will be used
  * to fetch the records
  *
- * @param  array $params  name value pair of contact information
+ * @param array $params
+ *   Name value pair of contact information.
  * {@getfields GroupOrganization_get}
  * @example GroupOrganizationGet.php
  *
- * @return  array  list of groups, given contact subsribed to
+ * @return array
+ *   list of groups, given contact subsribed to
  */
 function civicrm_api3_group_organization_get($params) {
   return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
@@ -58,7 +59,8 @@ function civicrm_api3_group_organization_get($params) {
  * @example GroupOrganizationCreate.php
  * {@getfields GroupOrganization_create}
  *
- * @param $params array
+ * @param array $params
+ *   Array.
  *
  * @return array
  *
@@ -79,7 +81,8 @@ function civicrm_api3_group_organization_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_group_organization_create_spec(&$params) {
   $params['organization_id']['api.required'] = 1;
@@ -91,16 +94,16 @@ function _civicrm_api3_group_organization_create_spec(&$params) {
  *
  * This API is used for deleting a Group Organization
  *
- * @param  array  $params  with 'id' = ID of the Group Organization to be deleted
+ * @param array $params
+ *   With 'id' = ID of the Group Organization to be deleted.
  *
- * @return array API Result
+ * @return array
+ *   API Result
  * {@getfields GroupOrganization_delete}
  * @example GroupOrganizationDelete.php
- * @access public
  */
 function civicrm_api3_group_organization_delete($params) {
 
   $result = CRM_Contact_BAO_GroupOrganization::deleteGroupOrganization($params['id']);
   return $result ? civicrm_api3_create_success('Deleted Group Organization successfully') : civicrm_api3_create_error('Could not delete Group Organization');
 }
-