Api docblock cleanup.

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

diff --git a/api/v3/CustomSearch.php b/api/v3/CustomSearch.php
index c47b80aa7e3088438de566b334efdc868b47270f..1862a6329d034b1493732594d8440aa18d7b33ca 100644 (file)
--- a/api/v3/CustomSearch.php
+++ b/api/v3/CustomSearch.php
@@ -1,18 +1,45 @@
 <?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 custom search.
+ *
+ * @package CiviCRM_APIv3
+ */
 
 /**
- * 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
+ * @return array
+ *   details of found Option Values
  */
 function civicrm_api3_custom_search_get($params) {
   require_once 'api/v3/OptionValue.php';
@@ -23,17 +50,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
+ * @return array
+ *   Array of newly created option_value property values.
  */
 function civicrm_api3_custom_search_create($params) {
   require_once 'api/v3/OptionValue.php';
@@ -48,10 +70,12 @@ 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
+ * @param array $params
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_custom_search_create_spec(&$params) {
   require_once 'api/v3/OptionValue.php';
@@ -63,15 +87,12 @@ function _civicrm_api3_custom_search_create_spec(&$params) {
 }
 
 /**
- * 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';