X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FGroup.php;h=59ab73fcf4f097135fcfe28a8fa65bba5c1200f5;hb=b081365f52508bfd1fb0d3d15f3a0d48f5e9df12;hp=d4fa3c26b3780ef844c75ad4961058b49bbc4f27;hpb=0aa0303c4788bb09dc66277381158876dff6c056;p=civicrm-core.git

diff --git a/api/v3/Group.php b/api/v3/Group.php
index d4fa3c26b3..59ab73fcf4 100644
--- a/api/v3/Group.php
+++ b/api/v3/Group.php
@@ -26,30 +26,22 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM groups.
+ *
+ * This api is for creating/deleting groups or fetching a list of existing groups.
+ * To add/remove contacts to a group, use the groupContact api instead.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Group
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Group.php 30171 2010-10-14 09:11:27Z mover $
  */
 
 /**
- * create/update group
- *
- * This API is used to create new group or update any of the existing
- * In case of updating existing group, id of that particular group must
- * be in $params array. Either id or name is required field in the
- * $params array
+ * Create/update group.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'group'
+ *   name/value pairs to insert in new 'group'
  *
  * @return array
  *   API result array
- * @example GroupCreate.php
- * {@getfields group_create}
  */
 function civicrm_api3_group_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Group');
@@ -61,7 +53,7 @@ function civicrm_api3_group_create($params) {
  * 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_create_spec(&$params) {
   $params['is_active']['api.default'] = 1;
@@ -69,17 +61,13 @@ function _civicrm_api3_group_create_spec(&$params) {
 }
 
 /**
- * Returns array of groups  matching a set of one or more group properties
+ * Returns array of groups matching a set of one or more group properties.
  *
  * @param array $params
- *   Array of one or more valid.
- *                       property_name=>value pairs. If $params is set
- *                       as null, all groups will be returned
+ *   Array of properties. If empty, all records will be returned.
  *
  * @return array
  *   Array of matching groups
- * @example GroupGet.php
- * {@getfields group_get}
  */
 function civicrm_api3_group_get($params) {
   $options = _civicrm_api3_get_options_from_params($params, TRUE, 'group', 'get');
@@ -95,20 +83,13 @@ function civicrm_api3_group_get($params) {
 }
 
 /**
- * delete an existing group
- *
- * This method is used to delete any existing group. id of the group
- * to be deleted is required field in $params array
+ * Delete an existing group.
  *
  * @param array $params
- *   Array containing id of the group.
- *                       to be deleted
+ *   [id]
  *
  * @return array
  *   API result array
- * @example GroupDelete.php
- * {@getfields group_delete}
- *
  */
 function civicrm_api3_group_delete($params) {