INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/Membership.php b/api/v3/Membership.php
index 180e78d9261f5be25441d96b54f1fbe816da7836..d16aff5ec8adefe789de517dbdd6ab64c39d06c7 100644 (file)
--- a/api/v3/Membership.php
+++ b/api/v3/Membership.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -42,12 +41,12 @@
  *
  * This API is used for deleting a contact membership
  *
- * @param $params
+ * @param array $params
  *   Array array holding id - Id of the contact membership to be deleted.
  *
- * @return array api result
+ * @return array
+ *   api result
  * {@getfields membership_delete}
- * @access public
  */
 function civicrm_api3_membership_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -62,9 +61,9 @@ function civicrm_api3_membership_delete($params) {
  * @param array $params
  *   An associative array of name/value property values of civicrm_membership.
  *
- * @return array of newly created membership property values.
+ * @return array
+ *   Array of newly created membership property values.
  * {@getfields membership_create}
- * @access public
  */
 function civicrm_api3_membership_create($params) {
   // check params for membership id during update
@@ -187,10 +186,8 @@ function _civicrm_api3_membership_get_spec(&$params) {
  *          options affecting the desired results; has legacy support
  *          for just passing the contact_id itself as the argument
  *
- * @return  Array of all found membership property values.
- * @access public
- * @todo needs some love - basically only a get for a given contact right now
- * {@getfields membership_get}
+ * @return array
+ *   Array of all found membership property values.
  */
 function civicrm_api3_membership_get($params) {
   $activeOnly = $membershipTypeId = $membershipType = NULL;
@@ -237,7 +234,8 @@ function civicrm_api3_membership_get($params) {
  * @param int $membershipTypeId
  * @param $activeOnly
  *
- * @return array result for calling function
+ * @return array
+ *   result for calling function
  */
 function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) {
   // get the membership for the given contact ID
@@ -259,7 +257,8 @@ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTyp
  * @param $membershipValues
  * @param int $contactID
  *
- * @return array result for calling function
+ * @return array
+ *   result for calling function
  */
 function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params, $membershipValues, $contactID) {
   $relationships = array();