INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/MembershipBlock.php b/api/v3/MembershipBlock.php
index 100f712e9eae3b85c000782d3686d89766a30991..acfb043ebad4304072043a2f2d572ead85eed34e 100644 (file)
--- a/api/v3/MembershipBlock.php
+++ b/api/v3/MembershipBlock.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -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_block
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership_block.
  *
- * @return array $result newly created or updated membership type property values.
- * @access public
- * {getfields MembershipBlock_get}
+ * @return array
+ *   newly created or updated membership type property values.
  */
 function civicrm_api3_membership_block_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -54,7 +53,8 @@ function civicrm_api3_membership_block_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_block_create_spec(&$params) {
   $params['is_active']['api.default'] = TRUE;
@@ -67,11 +67,12 @@ function _civicrm_api3_membership_block_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_block
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership_block.
  * {getfields MembershipBlock_get}
  *
- * @return array api result array of all found membership block property values.
- * @access public
+ * @return array
+ *   api result array of all found membership block property values.
  */
 function civicrm_api3_membership_block_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -83,13 +84,11 @@ function civicrm_api3_membership_block_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 array api result array
- * @access public
- * {getfields MembershipBlock_delete}
+ * @return array
+ *   api result array
  */
 function civicrm_api3_membership_block_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
-