Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2015-03-09-21-44-34

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

diff --git a/api/v3/OptionGroup.php b/api/v3/OptionGroup.php
index c65ffee5e3eae5f2d221d02ccc5e9e5da640adbb..bbe9bd50db31afbd4179cdc7cc4832f831df9693 100644 (file)
--- a/api/v3/OptionGroup.php
+++ b/api/v3/OptionGroup.php
@@ -27,11 +27,10 @@
 
 /**
  * This api exposes CiviCRM option groups.
- * Each group contains option values.
  *
- * @package CiviCRM_APIv3
- * @subpackage API_OptionValue
+ * OptionGroups are containers for option values.
  *
+ * @package CiviCRM_APIv3
  */
 
 /**
@@ -63,7 +62,7 @@ function civicrm_api3_option_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_option_group_create_spec(&$params) {
   $params['name']['api.unique'] = 1;
@@ -72,8 +71,7 @@ function _civicrm_api3_option_group_create_spec(&$params) {
 /**
  * Delete an existing Option Group.
  *
- * This method is used to delete any existing Option Group. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing OptionGroup given its id.
  *
  * @param array $params
  *   [id]