X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FOptionGroup.php;h=cfe6ed7a35f625e7472a5e18c746536902410efd;hb=61fe4988936f8bb28644451af665a141d6eb4c7b;hp=545b6c71ec8dff9c6d2c9606b3543e48a0bd2b87;hpb=ebda93be0f6455153d39b373426d997021401927;p=civicrm-core.git

diff --git a/api/v3/OptionGroup.php b/api/v3/OptionGroup.php
index 545b6c71ec..cfe6ed7a35 100644
--- a/api/v3/OptionGroup.php
+++ b/api/v3/OptionGroup.php
@@ -1,7 +1,9 @@
 <?php
 
 /**
- * @param $params
+ * Get option groups.
+ *
+ * @param array $params
  *
  * @return array
  */
@@ -16,40 +18,43 @@ function civicrm_api3_option_group_get($params) {
  * In case of updating existing survey, id of that particular survey must
  * be in $params array.
  *
- * @param array $params  (reference) Associative array of property
+ * @param array $params
+ *   (reference) Associative array of property.
  *   name/value pairs to insert in new 'survey'
  *
- * @return array   survey array
+ * @return array
+ *   survey array
  *
- * @access public
  */
 function civicrm_api3_option_group_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
  *
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_option_group_create_spec(&$params) {
   $params['name']['api.unique'] = 1;
 }
 
 /**
- * delete an existing Option Group
+ * 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
  *
- * @param array $params array containing id of the group
+ * @param array $params
+ *   Array containing id of the group.
  *                       to be deleted
  *
- * @return array API Result Array
- *                message otherwise
- * {@getfields OptionGroup_delete}
- * @access public
+ * @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);