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 cfe6ed7a35f625e7472a5e18c746536902410efd..bbe9bd50db31afbd4179cdc7cc4832f831df9693 100644 (file)
--- a/api/v3/OptionGroup.php
+++ b/api/v3/OptionGroup.php
@@ -1,4 +1,37 @@
 <?php
+/*
+ +--------------------------------------------------------------------+
+ | CiviCRM version 4.6                                                |
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
+ +--------------------------------------------------------------------+
+ | This file is a part of CiviCRM.                                    |
+ |                                                                    |
+ | CiviCRM is free software; you can copy, modify, and distribute it  |
+ | under the terms of the GNU Affero General Public License           |
+ | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ |                                                                    |
+ | CiviCRM is distributed in the hope that it will be useful, but     |
+ | WITHOUT ANY WARRANTY; without even the implied warranty of         |
+ | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
+ | See the GNU Affero General Public License for more details.        |
+ |                                                                    |
+ | You should have received a copy of the GNU Affero General Public   |
+ | License and the CiviCRM Licensing Exception along                  |
+ | with this program; if not, contact CiviCRM LLC                     |
+ | at info[AT]civicrm[DOT]org. If you have questions about the        |
+ | GNU Affero General Public License or the licensing of CiviCRM,     |
+ | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ * This api exposes CiviCRM option groups.
+ *
+ * OptionGroups are containers for option values.
+ *
+ * @package CiviCRM_APIv3
+ */
 
 /**
  * Get option groups.
@@ -12,19 +45,12 @@ function civicrm_api3_option_group_get($params) {
 }
 
 /**
- * create/update survey
- *
- * This API is used to create new survey or update any of the existing
- * In case of updating existing survey, id of that particular survey must
- * be in $params array.
+ * Create/update option group.
  *
  * @param array $params
- *   (reference) Associative array of property.
- *   name/value pairs to insert in new 'survey'
+ *   Array per getfields metadata.
  *
  * @return array
- *   survey array
- *
  */
 function civicrm_api3_option_group_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -36,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;
@@ -45,16 +71,13 @@ 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
- *   Array containing id of the group.
- *                       to be deleted
+ *   [id]
  *
  * @return array
  *   API Result Array
- *   {@getfields OptionGroup_delete}
  */
 function civicrm_api3_option_group_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);