X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FParticipantStatusType.php;h=23a4a74a13275debfbd8957831995ca82bfc3073;hb=0b2bdd13e190523e68f8ee762b825eaa0a801e4b;hp=32d7f2707203ed59b5a9e9b6419fce4f6a370d4c;hpb=1024e1784fb68b8529a77143f5191a60d70837cf;p=civicrm-core.git

diff --git a/api/v3/ParticipantStatusType.php b/api/v3/ParticipantStatusType.php
index 32d7f27072..23a4a74a13 100644
--- a/api/v3/ParticipantStatusType.php
+++ b/api/v3/ParticipantStatusType.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -27,61 +26,52 @@
  */
 
 /**
- * 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'
+ * @param array $params
+ *   name/value pairs to insert in new 'participant_status'
  *
- * @return array   participant_status array
- * {@getfields ParticipantStatusType_create}
- * @example ParticipantStatusTypeCreate.php
- * @access public
+ * @return array
+ *   participant_status array
  */
 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
+ * @param array $params
+ *   Array of properties. If empty, all records will be returned.
  *
- * @return array Array of matching participant_statuses
- * {@getfields ParticipantStatusType_get}
- * @example ParticipantStatusTypeGet.php
- * @access public
+ * @return array
+ *   Array of matching participant_statuses
  */
 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
  *
- * @param array $params  (reference) array containing id of the group
- *                       to be deleted
+ * @param array $params
+ *   [id]
  *
- * @return array api result array
- * {@getfields ParticipantStatusType_delete}
- * @example ParticipantStatusTypeDelete.php
- * @access public
+ * @return array
+ *   api result array
  */
 function civicrm_api3_participant_status_type_delete($params) {
   if (CRM_Event_BAO_ParticipantStatusType::deleteParticipantStatusType($params['id'])) {
@@ -90,4 +80,3 @@ function civicrm_api3_participant_status_type_delete($params) {
 
   return civicrm_api3_create_error(TRUE);
 }
-