Merge pull request #4923 from colemanw/invoice_id

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

diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php
index 8fc6203be219059073e1330e03e44ead0d7522f0..eef2a96ad0deb0221ee927dc4b5dd3a106ff3170 100644 (file)
--- a/api/v3/MembershipType.php
+++ b/api/v3/MembershipType.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -40,11 +39,11 @@
 /**
  * API to Create or update a Membership Type
  *
- * @param   array  $params  an associative array of name/value property values of civicrm_membership_type
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership_type.
  *
- * @return array $result newly created or updated membership type property values.
- * @access public
- * {getfields MembershipType_get}
+ * @return array
+ *   newly created or updated membership type property values.
  */
 function civicrm_api3_membership_type_create($params) {
   $ids['membershipType'] = CRM_Utils_Array::value('id', $params);
@@ -64,13 +63,14 @@ function civicrm_api3_membership_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_membership_type_create_spec(&$params) {
   // todo could set default here probably
   $params['domain_id']['api.required'] = 1;
   $params['member_of_contact_id']['api.required'] = 1;
-  $params['financial_type_id']['api.required'] =1;
+  $params['financial_type_id']['api.required'] = 1;
   $params['name']['api.required'] = 1;
   $params['duration_unit']['api.required'] = 1;
   $params['duration_interval']['api.required'] = 1;
@@ -81,11 +81,12 @@ function _civicrm_api3_membership_type_create_spec(&$params) {
  *
  * This api is used for finding an existing membership type.
  *
- * @param  array $params  an associative array of name/value property values of civicrm_membership_type
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership_type.
  * {getfields MembershipType_get}
  *
- * @return  Array of all found membership type property values.
- * @access public
+ * @return array
+ *   Array of all found membership type property values.
  */
 function civicrm_api3_membership_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -97,13 +98,11 @@ function civicrm_api3_membership_type_get($params) {
  * This API is used for deleting a membership type
  * Required parameters : id of a membership type
  *
- * @param  array $params
+ * @param array $params
  *
- * @return boolean        true if success, else false
- * @access public
- * {getfields MembershipType_delete}
+ * @return boolean
+ *   true if success, else false
  */
 function civicrm_api3_membership_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-