Merge pull request #6378 from johanv/CRM-15991-permission_delete_relationship

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

diff --git a/api/v3/ParticipantStatusType.php b/api/v3/ParticipantStatusType.php
index 9b8870f87641aaa4f46b35b938c0fcffd01ad6af..3160b91d28f20b6f80456c02736ed235378ca911 100644 (file)
--- a/api/v3/ParticipantStatusType.php
+++ b/api/v3/ParticipantStatusType.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,64 +26,51 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM participant status options.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Event
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 /**
- * create/update participant_status
+ * Create/update participant_status.
  *
  * This API is used to create new participant_status or update any of the existing
  * In case of updating existing participant_status, id of that particular participant_status must
  * be in $params array.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'participant_status'
+ *   name/value pairs to insert in new 'participant_status'
  *
  * @return array
  *   participant_status array
- *   {@getfields ParticipantStatusType_create}
- * @example ParticipantStatusTypeCreate.php
  */
 function civicrm_api3_participant_status_type_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Returns array of participant_statuses  matching a set of one or more group properties
+ * Returns array of participant_statuses matching a set of one or more group properties.
  *
  * @param array $params
- *   Array of one or more valid.
- *                       property_name=>value pairs. If $params is set
- *                       as null, all participant_statuses will be returned
+ *   Array of properties. If empty, all records will be returned.
  *
  * @return array
  *   Array of matching participant_statuses
- *   {@getfields ParticipantStatusType_get}
- * @example ParticipantStatusTypeGet.php
  */
 function civicrm_api3_participant_status_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * delete an existing participant_status
+ * Delete an existing participant_status.
  *
- * This method is used to delete any existing participant_status. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing participant_status given its id.
  *
  * @param array $params
- *   (reference) array containing id of the group.
- *                       to be deleted
+ *   [id]
  *
  * @return array
  *   api result array
- *   {@getfields ParticipantStatusType_delete}
- * @example ParticipantStatusTypeDelete.php
  */
 function civicrm_api3_participant_status_type_delete($params) {
   if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) {