Api docblock cleanup.

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

diff --git a/api/v3/LocationType.php b/api/v3/LocationType.php
index 73568b998fb3b9e111b4efd2edbfd91ca246b033..5293a445e87612c485129f13faa2015c37dcd185 100644 (file)
--- a/api/v3/LocationType.php
+++ b/api/v3/LocationType.php
@@ -23,30 +23,21 @@
  | 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 location type functions
+ * This api exposes CiviCRM location type.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_LocationType
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: LocationType.php 2012-11-02 Jon Goldberg $
  */
 
 /**
- * Add a Location Type
- *
- * Allowed @params array keys are:
- *
- * @example LocationTypeCreate.php Standard Create Example
+ * Add a Location Type.
  *
  * @param array $params
  *
  * @return array
- *   API result array
- *   {@getfields email_create}
+ *   API result array.
  */
 function civicrm_api3_location_type_create($params) {
   //set display_name equal to name if it's not defined
@@ -58,11 +49,12 @@ function civicrm_api3_location_type_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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_location_type_create_spec(&$params) {
   $params['is_active']['api.default'] = 1;
@@ -70,31 +62,25 @@ function _civicrm_api3_location_type_create_spec(&$params) {
 }
 
 /**
- * Deletes an existing Location Type
+ * Deletes an existing Location Type.
  *
  * @param array $params
  *
- * @example LocationTypeDelete.php Standard Delete Example
- *
  * @return array
- *   API result array
- *   {@getfields LocationType_delete}
+ *   API result array.
  */
 function civicrm_api3_location_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Retrieve one or more Location Types
- *
- * @example LocationTypeGet.php Standard Get Example
+ * Retrieve one or more Location Types.
  *
  * @param array $params
  *   An associative array of name/value pairs.
  *
  * @return array
- *   api result
- *   {@getfields LocationType_get}
+ *   API result array.
  */
 function civicrm_api3_location_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);