Api docblock cleanup.

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

diff --git a/api/v3/Phone.php b/api/v3/Phone.php
index 5b64093b5ec642921e43dbdca309ac45d5b24483..599ee8ce7c385e40c66236c2f04cafb5ec785490 100644 (file)
--- a/api/v3/Phone.php
+++ b/api/v3/Phone.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,41 +23,34 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 phone functions
+ * This api exposes CiviCRM phone.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Phone
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Phone.php 2011-03-16 ErikHommel $
  */
 
 /**
- *  Add an Phone for a contact
- *
- * Allowed @params array keys are:
- * {@getfields phone_create}
- * @example PhoneCreate.php
+ * Add an Phone for a contact.
  *
  * @param array $params
+ *   Array per getfields metadata.
  *
  * @return array
  *   Array of newly created phone property values.
- * @access public
  */
 function civicrm_api3_phone_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Phone');
 }
 
 /**
- * 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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_phone_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -68,15 +60,13 @@ function _civicrm_api3_phone_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing Phone
+ * Delete an existing Phone.
  *
  * @param array $params
+ *   Array per getfields metadata.
  *
  * @return array
  *   Api Result
- * {@getfields phone_delete}
- * @example PhoneDelete.php
- * @access public
  */
 function civicrm_api3_phone_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -86,5 +76,4 @@ function civicrm_api3_phone_delete($params) {
  *  civicrm_api('Phone','Get') to retrieve one or more phones is implemented by
  *  function civicrm_api3_phone_get ($params) into the file Phone/Get.php
  *  Could have been implemented here in this file too, but we moved it to illustrate the feature with a real usage.
- *
  */