blindsidenetworks / moodle-mod_bigbluebuttonbn

lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -97,7 +97,7 @@ 
  * @uses FEATURE_GRADE_OUTCOMES
  * @uses FEATURE_SHOW_DESCRIPTION
  * @param string $feature
- * @return mixed True if yes (some features may use other values)
+ * @return null|boolean True if yes (some features may use other values)
  */
 function bigbluebuttonbn_supports($feature) {
     if (!$feature) {
@@ -239,7 +239,7 @@ 
  * @param object $mod
  * @param object $bigbluebuttonbn
  *
- * @return bool
+ * @return string
  */
 function bigbluebuttonbn_user_outline($course, $user, $mod, $bigbluebuttonbn) {
     global $DB;
@@ -542,7 +542,7 @@ 
  * @param stdClass $context       context object
  * @param string   $filearea      file area
  *
- * @return false|null false if file not valid
+ * @return boolean false if file not valid
  */
 function bigbluebuttonbn_pluginfile_valid($context, $filearea) {
     if ($context->contextlevel != CONTEXT_MODULE) {

locallib.php

Doc Comments +19 added lines, -9 removed lines

@@ -326,7 +326,7 @@ 
 /**
  * Helper function to retrive the default config.xml file.
  *
- * @return string
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_get_default_config_xml() {
     $xml = bigbluebuttonbn_wrap_xml_load_file(
@@ -397,7 +397,7 @@ 
  * @param object $a
  * @param object $b
  *
- * @return array
+ * @return integer
  */
 function bigbluebuttonbn_recording_build_sorter($a, $b) {
     if ($a['startTime'] < $b['startTime']) {
@@ -523,7 +523,7 @@ 
  * @param string $data
  * @param string $contenttype
  *
- * @return object
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_wrap_xml_load_file($url, $method = 'GET', $data = null, $contenttype = 'text/xml') {
     if (extension_loaded('curl')) {
@@ -564,7 +564,7 @@ 
  * @param string $data
  * @param string $contenttype
  *
- * @return object
+ * @return string
  */
 function bigbluebuttonbn_wrap_xml_load_file_curl_request($url, $method = 'GET', $data = null, $contenttype = 'text/xml') {
     $c = new curl();
@@ -604,7 +604,7 @@ 
  * Returns user roles in a context.
  *
  * @param context $context
- * @param context $userid
+ * @param integer $userid
  *
  * @return array $userroles
  */
@@ -928,7 +928,7 @@ 
  *
  * @param integer $voicebridge
  *
- * @return string
+ * @return boolean
  */
 function bigbluebuttonbn_voicebridge_unique($voicebridge) {
     global $DB;
@@ -1028,7 +1028,7 @@ 
 /**
  * Helper returns an array with all possible bigbluebuttonbn events.
  *
- * @return array
+ * @return string[]
  */
 function bigbluebuttonbn_events() {
     return array(
@@ -1237,7 +1237,7 @@ 
  * @param string $meetingid
  * @param string $configxml
  *
- * @return object
+ * @return null|SimpleXMLElement
  */
 function bigbluebuttonbn_set_config_xml($meetingid, $configxml) {
     $urldefaultconfig = \mod_bigbluebuttonbn\locallib\config::get('server_url').'api/setConfigXML?';
@@ -1442,6 +1442,9 @@ 
     return $OUTPUT->action_link('#', $title, null, $linkattributes);
 }
 
+/**
+ * @param boolean $editable
+ */
 function bigbluebuttonbn_get_recording_data_row_meta_activity($recording, $editable) {
     $payload = array();
     if ($editable) {
@@ -1463,6 +1466,9 @@ 
     return bigbluebuttonbn_get_recording_data_row_text($recording, $metaname, $newsource, $payload);
 }
 
+/**
+ * @param boolean $editable
+ */
 function bigbluebuttonbn_get_recording_data_row_meta_description($recording, $editable) {
     $payload = array();
     if ($editable) {
@@ -1483,6 +1489,10 @@ 
     return bigbluebuttonbn_get_recording_data_row_text($recording, '', $newsource, $payload);
 }
 
+/**
+ * @param string $text
+ * @param string $source
+ */
 function bigbluebuttonbn_get_recording_data_row_text($recording, $text, $source, $data) {
     $htmltext = '<span>' . htmlentities($text) . '</span>';
     if (empty($data)) {
@@ -1757,7 +1767,7 @@ 
  * Helper function to define the sql used for gattering the bigbluebuttonbnids whose meetingids should be included
  * in the getRecordings request considering only those that belong to deleted activities.
  *
- * @param string $courseid
+ * @param integer $courseid
  * @param string $bigbluebuttonbnid
  * @param bool   $subset
  *