Dev Fixing docblocks

LimeSurvey · Oct 28, 2019 · b999def · b999def
1 parent 212be23
commit b999def
Showing 1 changed file with 38 additions and 19 deletions.
diff --git a/application/helpers/remotecontrol/remotecontrol_handle.php b/application/helpers/remotecontrol/remotecontrol_handle.php
@@ -307,8 +307,8 @@ public function copy_survey($sSessionKey, $iSurveyID_org, $sNewname)
 
     /**
      * Get survey properties (RPC function)
+     * 
      * Get properties of a survey
-     *
      * All internal properties of a survey are available.
      * @see \Survey for the list of available properties
      *
@@ -583,6 +583,7 @@ public function export_statistics($sSessionKey, $iSurveyID, $docType = 'pdf', $s
 
     /**
      * Export submission timeline (RPC function)
+     * 
      * Returns an array of values (count and period)
      *
      * @access public
@@ -973,7 +974,8 @@ public function set_language_properties($sSessionKey, $iSurveyID, $aSurveyLocale
     /* Group specific functions */
 
     /**
-     * Add an empty page with minimum details to a survey (RPC function)
+     * Add empty page with minimum details (RPC function)
+     * 
      * Used as a placeholder for importing questions.
      * Returns the groupid of the created page.
      *
@@ -1019,6 +1021,7 @@ public function add_group($sSessionKey, $iSurveyID, $sGroupTitle, $sGroupDescrip
 
     /**
      * Delete a page from a chosen survey (RPC function)
+     * 
      * Returns the id of the deleted group.
      *
      * @access public
@@ -1152,6 +1155,7 @@ public function import_group($sSessionKey, $iSurveyID, $sImportData, $sImportDat
 
     /**
      * Find response IDs given a survey ID and a token (RPC function)
+     * 
      * @param string $sSessionKey
      * @param int $iSurveyID
      * @param string $sToken
@@ -1220,7 +1224,7 @@ public function get_group_properties($sSessionKey, $iGroupID, $aGroupSettings =
 
 
     /**
-     * Set group properties.
+     * Set group properties (RPC function)
      *
      * @see \QuestionGroup for available properties and restriction
      *
@@ -1295,7 +1299,8 @@ public function set_group_properties($sSessionKey, $iGroupID, $aGroupData)
 
 
     /**
-     * Delete a question from a survey .
+     * Delete question from a survey (RPC function)
+     * 
      * Returns the id of the deleted question.
      *
      * @access public
@@ -1358,6 +1363,8 @@ public function delete_question($sSessionKey, $iQuestionID)
 
 
     /**
+     * Import question (RPC function)
+     * 
      * Import a question from lsq file
      *
      * @access public
@@ -1718,7 +1725,7 @@ public function set_question_properties($sSessionKey, $iQuestionID, $aQuestionDa
 
 
     /**
-     * Add participants to the tokens collection of the survey.
+     * Add participants to the survey.
      *
      * The parameters $aParticipantData is a 2 dimensionnal array containing needed participant data.
      * @see \Token for all available attribute,
@@ -1768,7 +1775,8 @@ public function add_participants($sSessionKey, $iSurveyID, $aParticipantData, $b
     }
 
     /**
-     * Delete multiple participants from the survey participants table of a survey.
+     * Delete multiple participants from the survey participants table (RPC function)
+     * 
      * Returns the id of the deleted token
      *
      * @access public
@@ -1814,8 +1822,8 @@ public function delete_participants($sSessionKey, $iSurveyID, $aTokenIDs)
 
 
     /**
-     * Get settings of a token/participant of a survey.
-     *
+     * Get settings of a survey participant (RPC function)
+     * 
      * Allow to request for a specific participant. If more than one participant is returned with specified attribute(s) an error is returned.
      *
      * @access public
@@ -1874,7 +1882,7 @@ public function get_participant_properties($sSessionKey, $iSurveyID, $aTokenQuer
     }
 
     /**
-     * Set properties of a survey participant/token.
+     * Set properties of a survey participant (RPC function)
      *
      * Allow to set properties about a specific participant, only one particpant can be updated.
      * @see \Token for available properties
@@ -1941,7 +1949,9 @@ public function set_participant_properties($sSessionKey, $iSurveyID, $aTokenQuer
 
 
     /**
-     * Return the ids and all attributes of groups belonging to survey.
+     * Get survey pages (RPC function)
+     * 
+     * Returns the ids and all attributes of all survey pages
      *
      * @access public
      * @param string $sSessionKey Auth credentials
@@ -1976,7 +1986,7 @@ public function list_groups($sSessionKey, $iSurveyID)
     }
 
     /**
-     * Return the ids and propertries of token/participants of a survey.
+     * Return the ids and propertries of survey participants (RPC function)
      *
      * if $bUnused is true, user will get the list of uncompleted tokens (token_return functionality).
      * Parameters iStart and iLimit are used to limit the number of results of this call.
@@ -2061,7 +2071,8 @@ public function list_participants($sSessionKey, $iSurveyID, $iStart = 0, $iLimit
     }
 
     /**
-     * Return the ids and info of (sub-)questions of a survey/group.
+     * Return the ids and info of (sub-)questions of a survey/group (RPC function)
+     * 
      * Returns array of ids and info.
      *
      * @access public
@@ -2121,7 +2132,8 @@ public function list_questions($sSessionKey, $iSurveyID, $iGroupID = null, $sLan
     }
 
     /**
-     * Set Quota Attributes
+     * Set quota attributes (RPC function)
+     * 
      * Retuns an array containing the boolean 'success' and 'message' with either errors or Quota attributes (on success)
      * @access public
      * @param string $sSessionKey Auth credentials
@@ -2167,7 +2179,7 @@ public function set_quota_properties($sSessionKey, $iQuotaId, $aQuotaData)
     }
 
     /**
-     * List the survey belonging to a user
+     * List the survey belonging to a user (RPC function)
      *
      * If user is admin he can get surveys of every user (parameter sUser) or all surveys (sUser=null)
      * Else only the surveys belonging to the user requesting will be shown.
@@ -2221,7 +2233,7 @@ public function list_surveys($sSessionKey, $sUsername = null)
     }
 
 /**
- * Get list the ids and info of users.
+ * Get list the ids and info of administration user(s) (RPC function)
  *
  * Returns array of ids and info.
  *
@@ -2270,7 +2282,9 @@ public function list_users($sSessionKey = null, $uid = null)
     }
 
     /**
-     * Initialise the token system of a survey where new participant tokens may be later added.
+     * Activate survey participants (RPC function)
+     * 
+     * Initialise the survey participant table of a survey where new participant tokens may be later added.
      *
      * @access public
      * @param string $sSessionKey Auth credentials
@@ -2308,7 +2322,7 @@ public function activate_tokens($sSessionKey, $iSurveyID, $aAttributeFields = ar
     }
 
     /**
-     * Send register mails to participants in a survey
+     * Send e-mails to registered participants in a survey (RPC function)
      *
      * Returns array of results of sending
      *
@@ -2401,7 +2415,7 @@ public function mail_registered_participants($sSessionKey, $iSurveyID, $override
     }
 
     /**
-     * Invite participants in a survey
+     * Invite participants in a survey (RPC function)
      *
      * Returns array of results of sending
      *
@@ -2467,7 +2481,8 @@ public function invite_participants($sSessionKey, $iSurveyID, $aTokenIds = null,
 
 
     /**
-     * Send a reminder to participants in a survey
+     * Send a reminder to participants in a survey (RPC function) 
+     * 
      * Returns array of results of sending
      *
      * @access public
@@ -2541,6 +2556,7 @@ public function remind_participants($sSessionKey, $iSurveyID, $iMinDaysBetween =
 
     /**
      * Add a response to the survey responses collection.
+     * 
      * Returns the id of the inserted survey response
      *
      * @access public
@@ -2632,6 +2648,7 @@ public function add_response($sSessionKey, $iSurveyID, $aResponseData)
 
     /**
      * Update a response in a given survey.
+     * 
      * Routine supports only single response updates.
      * Response to update will be identified either by the response id, or the token if response id is missing.
      * Routine is only applicable for active surveys with alloweditaftercompletion = Y.
@@ -2712,6 +2729,7 @@ public function update_response($sSessionKey, $iSurveyID, $aResponseData)
 
     /**
      * Uploads one file to be used later.
+     * 
      * Returns the metadata on success.
      *
      * @access public
@@ -2878,6 +2896,7 @@ public function export_responses($sSessionKey, $iSurveyID, $sDocumentType, $sLan
 
     /**
      * Export token response in a survey.
+     * 
      * Returns the requested file as base64 encoded string
      *
      * @access public