a few random comment fixes
[civicrm-core.git] / api / v3 / PaymentProcessorType.php
index 4ce8d997314a5a4efce8bf980cc4e63bc3e490e9..1cdac8dd31d15dfdee93ca7d5ec5d514fab1f091 100644 (file)
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  */
 
 /**
- * Function to create payment_processor type
+ * create payment_processor type
  *
- * @param  array $params   Associative array of property name/value pairs to insert in new payment_processor type.
+ * @param array $params
+ *   Associative array of property name/value pairs to insert in new payment_processor type.
  *
- * @return Newly created PaymentProcessor_type object
+ * @return array
  * {@getfields PaymentProcessorType_create}
  * @access public
  * {@schema Core/PaymentProcessorType.xml}
@@ -71,7 +71,8 @@ function civicrm_api3_payment_processor_type_create($params) {
  * Adjust Metadata for Create action
  *
  * 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_payment_processor_type_create_spec(&$params) {
   $params['billing_mode']['api.required'] = 1;
@@ -84,11 +85,13 @@ function _civicrm_api3_payment_processor_type_create_spec(&$params) {
 }
 
 /**
- * Function to get all payment_processor type
+ * get all payment_processor type
  * retruns  An array of PaymentProcessor_type
  * @access  public
  * {@getfields PaymentProcessorType_get}
  * @example PaymentProcessorTypeGet.php
+ * @param $params
+ * @return array
  */
 function civicrm_api3_payment_processor_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -97,11 +100,12 @@ function civicrm_api3_payment_processor_type_get($params) {
 /**
  * Delete a payment_processor type delete
  *
- * @param  id of payment_processor type  $id
+ * @param id of payment_processor type $id
  *
- * @return array API Result Array
+ * @return array
+ *   API Result Array
  * {@getfields PaymentProcessorType_delete}
- * @static void
+ * @static
  * @access public
  */
 function civicrm_api3_payment_processor_type_delete($params) {