INFRA-132 - api - Convert single-line @param to multi-line
[civicrm-core.git] / api / v3 / GroupOrganization.php
index b683a9e3838d32b5f30dd65e4fec12675b2bcc1d..e084b8007218c9ef3279a70ed9d6395c30ee40bf 100644 (file)
@@ -2,9 +2,9 @@
 
 /*
  +--------------------------------------------------------------------+
- | 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 +32,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,7 +44,8 @@
  * 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
  *
@@ -58,7 +59,8 @@ function civicrm_api3_group_organization_get($params) {
  * @example GroupOrganizationCreate.php
  * {@getfields GroupOrganization_create}
  *
- * @param $params array
+ * @param $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,7 +94,8 @@ 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
  * {@getfields GroupOrganization_delete}