<?php
/**
- * Retrieve a CustomSearches
+ * Retrieve custom searches.
*
* FIXME This is a bare-minimum placeholder
*
- * @param $params
+ * @param array $params
*
- * @internal param $array $ params input parameters
- *
- * {@example OptionValueGet.php 0}
- * @example OptionValueGet.php
- *
- * @return array details of found Option Values
- * {@getfields OptionValue_get}
- * @access public
+ * @return array
+ * details of found Option Values
*/
function civicrm_api3_custom_search_get($params) {
require_once 'api/v3/OptionValue.php';
}
/**
- * Add a CustomSearch
- *
- * Allowed @params array keys are:
+ * Add a CustomSearch.
*
- * {@example OptionValueCreate.php}
+ * @param array $params
*
- * @param $params
- *
- * @return array of newly created option_value property values.
- * {@getfields OptionValue_create}
- * @access public
+ * @return array
+ * Array of newly created option_value property values.
*/
function civicrm_api3_custom_search_create($params) {
require_once 'api/v3/OptionValue.php';
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
- * 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_custom_search_create_spec(&$params) {
require_once 'api/v3/OptionValue.php';
}
/**
- * Deletes an existing ReportTemplate
- *
- * @param array $params
+ * Deletes an existing ReportTemplate.
*
- * {@example ReportTemplateDelete.php 0}
+ * @param array $params
*
- * @return array Api result
- * {@getfields ReportTemplate_create}
- * @access public
+ * @return array
+ * Api result
*/
function civicrm_api3_custom_search_delete($params) {
require_once 'api/v3/OptionValue.php';