INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/GroupNesting.php b/api/v3/GroupNesting.php
index 4fe076c6f37df909a85d2d64a709831fc9974f60..a6643f1af55311ef93dd020138318df7c902fca7 100644 (file)
--- a/api/v3/GroupNesting.php
+++ b/api/v3/GroupNesting.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,10 +39,12 @@
 /**
  * Provides group nesting record(s) given parent and/or child id.
  *
- * @param array $params  an array containing at least child_group_id or parent_group_id
+ * @param array $params
+ *   An array containing at least child_group_id or parent_group_id.
  * {@getfields GroupNesting_get}
  *
- * @return  array  list of group nesting records
+ * @return array
+ *   list of group nesting records
  */
 function civicrm_api3_group_nesting_get($params) {
 
@@ -54,9 +55,11 @@ function civicrm_api3_group_nesting_get($params) {
  * Creates group nesting record for given parent and child id.
  * Parent and child groups need to exist.
  *
- * @param array $params parameters array - allowed array keys include:
+ * @param array $params
+ *   Parameters array - allowed array keys include:.
  *
- * @return array TBD
+ * @return array
+ *   TBD
  * {@getfields GroupNesting_create
  * @todo Work out the return value.
  */
@@ -73,7 +76,8 @@ function civicrm_api3_group_nesting_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_nesting_create_spec(&$params) {
   $params['child_group_id']['api.required'] = 1;
@@ -83,10 +87,12 @@ function _civicrm_api3_group_nesting_create_spec(&$params) {
 /**
  * Removes specific nesting records.
  *
- * @param array $params parameters array - allowed array keys include:
+ * @param array $params
+ *   Parameters array - allowed array keys include:.
  * {@getfields GroupNesting_delete}
  *
- * @return array API Success or fail array
+ * @return array
+ *   API Success or fail array
  *
  * @todo Work out the return value.
  */
@@ -94,4 +100,3 @@ function civicrm_api3_group_nesting_delete($params) {
 
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-