comment fixes

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

diff --git a/api/v3/Survey.php b/api/v3/Survey.php
index 2a9334a5d2512191df57502abf8679b2184c6eb3..f270127a2188e9c0bac80df0d2b06afd568ed782 100644 (file)
--- a/api/v3/Survey.php
+++ b/api/v3/Survey.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -36,26 +35,23 @@
 
 
 /**
- * Create or update a survey
+ * Create or update a survey.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'survey'
- * @example SurveyCreate.php Std Create example
+ *   Array per getfields metadata.
  *
  * @return array
  *   api result array
- * {@getfields survey_create}
- * @access public
  */
 function civicrm_api3_survey_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Survey');
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
  *   Array or parameters determined by getfields.
  */
@@ -64,7 +60,7 @@ function _civicrm_api3_survey_create_spec(&$params) {
 }
 
 /**
- * Returns array of surveys  matching a set of one or more group properties
+ * Returns array of surveys  matching a set of one or more group properties.
  *
  * @param array $params
  *   Array of one or more valid.
@@ -73,15 +69,13 @@ function _civicrm_api3_survey_create_spec(&$params) {
  *
  * @return array
  *   API result Array of matching surveys
- * {@getfields survey_get}
- * @access public
  */
 function civicrm_api3_survey_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Survey');
 }
 
 /**
- * delete an existing survey
+ * Delete an existing survey.
  *
  * This method is used to delete any existing survey. id of the group
  * to be deleted is required field in $params array
@@ -92,8 +86,6 @@ function civicrm_api3_survey_get($params) {
  *
  * @return array
  *   api result array
- * {@getfields survey_delete}
- * @access public
  */
 function civicrm_api3_survey_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);