Update debugging page text

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

diff --git a/api/v3/GroupOrganization.php b/api/v3/GroupOrganization.php
index 8d8d2f70bbaf5eba4d36b0d38595810d4282cdd7..73a643785536cccc65bb95155b0122a53c4929a2 100644 (file)
--- a/api/v3/GroupOrganization.php
+++ b/api/v3/GroupOrganization.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -27,43 +26,32 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group contact functions
+ * This api exposes the relationships between organizations and CiviCRM groups.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Group
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: GroupContact.php 21624 2009-06-04 22:02:55Z mover $
- *
  */
 
 
 /**
- * This API will give list of the groups for particular contact
- * Particualr status can be sent in params array
- * If no status mentioned in params, by default 'added' will be used
- * to fetch the records
+ * Get group organization record/s.
  *
  * @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 subscribed to
  */
 function civicrm_api3_group_organization_get($params) {
   return _civicrm_api3_basic_get('CRM_Contact_DAO_GroupOrganization', $params);
 }
 
 /**
- * @example GroupOrganizationCreate.php
- * {@getfields GroupOrganization_create}
+ * Create group organization record.
  *
- * @param $params
+ * @param array $params
  *   Array.
  *
  * @return array
- *
  */
 function civicrm_api3_group_organization_create($params) {
 
@@ -78,11 +66,12 @@ function civicrm_api3_group_organization_create($params) {
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_group_organization_create_spec(&$params) {
   $params['organization_id']['api.required'] = 1;
@@ -90,21 +79,18 @@ function _civicrm_api3_group_organization_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing Group Organization
+ * Deletes an existing Group Organization.
  *
  * This API is used for deleting a Group Organization
  *
  * @param array $params
  *   With 'id' = ID of the Group Organization to be deleted.
  *
- * @return array API Result
- * {@getfields GroupOrganization_delete}
- * @example GroupOrganizationDelete.php
- * @access public
+ * @return array
+ *   API Result
  */
 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');
 }
-