More comment fixes

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

diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php
index 3d91e79642b51f1dab95589e4daeb050abcc49ee..3f34e8547449289272c9fc8633e343ea3c4880a5 100644 (file)
--- a/api/v3/CustomSearch.php
+++ b/api/v3/CustomSearch.php
@@ -1,19 +1,14 @@
 <?php
 
 /**
- * Retrieve a CustomSearches
+ * Retrieve custom searches.
  *
  * FIXME This is a bare-minimum placeholder
  *
  * @param array $params
  *
- * {@example OptionValueGet.php 0}
- * @example OptionValueGet.php
- *
  * @return array
  *   details of found Option Values
- * {@getfields OptionValue_get}
- * @access public
  */
 function civicrm_api3_custom_search_get($params) {
   require_once 'api/v3/OptionValue.php';
@@ -24,18 +19,12 @@ function civicrm_api3_custom_search_get($params) {
 }
 
 /**
- * Add a CustomSearch
- *
- * Allowed @params array keys are:
- *
- * {@example OptionValueCreate.php}
+ * Add a CustomSearch.
  *
  * @param array $params
  *
  * @return array
- *   of newly created option_value property values.
- * {@getfields OptionValue_create}
- * @access public
+ *   Array of newly created option_value property values.
  */
 function civicrm_api3_custom_search_create($params) {
   require_once 'api/v3/OptionValue.php';
@@ -50,9 +39,10 @@ function civicrm_api3_custom_search_create($params) {
 }
 
 /**
- * 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.
  */
@@ -66,16 +56,12 @@ function _civicrm_api3_custom_search_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing ReportTemplate
+ * Deletes an existing ReportTemplate.
  *
  * @param array $params
  *
- * {@example ReportTemplateDelete.php 0}
- *
  * @return array
  *   Api result
- * {@getfields ReportTemplate_create}
- * @access public
  */
 function civicrm_api3_custom_search_delete($params) {
   require_once 'api/v3/OptionValue.php';