Api docblock cleanup.

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

diff --git a/api/v3/Survey.php b/api/v3/Survey.php
index f270127a2188e9c0bac80df0d2b06afd568ed782..9bd314aed34fef833303ae4a809460743cb3528b 100644 (file)
--- a/api/v3/Survey.php
+++ b/api/v3/Survey.php
@@ -26,11 +26,13 @@
  */
 
 /**
- * File for the CiviCRM APIv3 group functions
+ * This api exposes CiviCRM survey/petition records.
+ *
+ * @note Campaign component must be enabled.
+ * @note There is no "petition" api.
+ * Surveys and petitions are the same basic object and this api is used for both.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Survey
- * @copyright CiviCRM LLC (c) 2004-2014
  */
 
 
@@ -53,7 +55,7 @@ function civicrm_api3_survey_create($params) {
  * The metadata is used for setting defaults, documentation & validation.
  *
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_survey_create_spec(&$params) {
   $params['title']['api.required'] = 1;
@@ -63,9 +65,7 @@ function _civicrm_api3_survey_create_spec(&$params) {
  * Returns array of surveys  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 surveys will be returned
+ *   Array of properties. If empty, all records will be returned.
  *
  * @return array
  *   API result Array of matching surveys
@@ -81,8 +81,7 @@ function civicrm_api3_survey_get($params) {
  * to be deleted is required field in $params array
  *
  * @param array $params
- *   Array containing id of the group.
- *                       to be deleted
+ *   [id]
  *
  * @return array
  *   api result array