Cleanup api3 docblocks

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

diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php
index 77b2f750ade335318de9c724ebb96510d8b84682..f6bdd31e49d646a0cc2267114dcd49cc37dc3f60 100644 (file)
--- a/api/v3/SurveyRespondant.php
+++ b/api/v3/SurveyRespondant.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -27,29 +26,32 @@
  */
 
 /**
- * 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
+ * @return string
+ *   to indicate this entire api entity is deprecated
  */
 function _civicrm_api3_survey_respondant_deprecation() {
   return 'The survey_respondant api is not currently supported.';
 }
 
 /**
- * Get the list of signatories
- *
- * @param  array   $params           (reference ) input parameters
+ * Get the list of signatories.
  *
- * @return array (reference )        contribution_id of created or updated record
- * @static void
- * @access public
  * @deprecated - api currently not supported
+ *
+ * @param array $params
+ *   input parameters.
+ *
+ * @return array
  */
 function civicrm_api3_survey_respondant_get(&$params) {
 
@@ -65,7 +67,7 @@ function civicrm_api3_survey_respondant_get(&$params) {
   $interviewerID = NULL;
   if (array_key_exists('interviewer_id', $params)) {
     $interviewerID = $params['interviewer_id'];
-}
+  }
 
   $statusIds = array();
   if (array_key_exists('status_id', $params)) {
@@ -78,7 +80,12 @@ function civicrm_api3_survey_respondant_get(&$params) {
 }
 
 /**
+ * Count survey respondents.
+ *
  * @deprecated - api currently not supported
+ *
+ * @param array $params
+ * @return array
  */
 function &civicrm_api3_survey_respondant_count($params) {
 
@@ -93,4 +100,3 @@ function &civicrm_api3_survey_respondant_count($params) {
   }
   return ($signaturesCount);
 }
-