Cleanup api3 docblocks

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

diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php
index 86da40035e528eeb974cad4bc1bdfb880e7d2f38..f6bdd31e49d646a0cc2267114dcd49cc37dc3f60 100644 (file)
--- a/api/v3/SurveyRespondant.php
+++ b/api/v3/SurveyRespondant.php
@@ -26,13 +26,15 @@
  */
 
 /**
- * File for the CiviCRM APIv3 Survey Respondant functions
+ * This api exposes CiviCRM Survey Respondant.
  *
  * @package CiviCRM_APIv3
  * @subpackage API_Survey
  */
 
 /**
+ * Notify caller of deprecated function.
+ *
  * @deprecated api notice
  * @return string
  *   to indicate this entire api entity is deprecated
@@ -42,10 +44,12 @@ function _civicrm_api3_survey_respondant_deprecation() {
 }
 
 /**
- * Get the list of signatories
+ * Get the list of signatories.
+ *
  * @deprecated - api currently not supported
+ *
  * @param array $params
- *   (reference ) input parameters.
+ *   input parameters.
  *
  * @return array
  */
@@ -76,7 +80,10 @@ function civicrm_api3_survey_respondant_get(&$params) {
 }
 
 /**
+ * Count survey respondents.
+ *
  * @deprecated - api currently not supported
+ *
  * @param array $params
  * @return array
  */