Merge pull request #6345 from pradpnayak/CRM-15187

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

diff --git a/api/v3/SurveyRespondant.php b/api/v3/SurveyRespondant.php
index 3ea6f75b276706dc06e35ef86ff2ad3e98535f10..88b31c492349325674d5d2e979b666643d3d2d18 100644 (file)
--- a/api/v3/SurveyRespondant.php
+++ b/api/v3/SurveyRespondant.php
@@ -26,32 +26,33 @@
  */
 
 /**
- * File for the CiviCRM APIv3 Survey Respondant functions
+ * This api exposes CiviCRM Survey Respondant.
+ *
+ * @deprecated - api currently not supported
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Survey
  */
 
 /**
+ * Notify caller of deprecated function.
+ *
  * @deprecated api notice
  * @return string
- *   to indicate this entire api entity is deprecated
+ *   String output indicates this entire api entity as deprecated
  */
 function _civicrm_api3_survey_respondant_deprecation() {
-  return 'The survey_respondant api is not currently supported.';
+  return 'The SurveyRespondant api is not currently supported.';
 }
 
 /**
- * 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
- *   (reference )        contribution_id of created or updated record
- * @static
- * @access public
- * @deprecated - api currently not supported
  */
 function civicrm_api3_survey_respondant_get(&$params) {
 
@@ -76,11 +77,14 @@ function civicrm_api3_survey_respondant_get(&$params) {
 
   $respondants = CRM_Campaign_BAO_Survey::getSurveyActivities($surveyID, $interviewerID, $statusIds);
 
-  return (civicrm_api3_create_success($respondants, $params));
+  return (civicrm_api3_create_success($respondants, $params, 'SurveyRespondant', 'get'));
 }
 
 /**
+ * Count survey respondents.
+ *
  * @deprecated - api currently not supported
+ *
  * @param array $params
  * @return array
  */