BOINC / boinc

html/user/submit_rpc_handler.php

Doc Comments +28 added lines

@@ -30,6 +30,9 @@ 
 ini_set('display_errors', true);
 ini_set('display_startup_errors', true);
 
+/**
+ * @param string $name
+ */
 function get_wu($name) {
     $name = BoincDb::escape_string($name);
     $wu = BoincWorkunit::lookup("name='$name'");
@@ -37,6 +40,9 @@ 
     return $wu;
 }
 
+/**
+ * @param string $name
+ */
 function get_submit_app($name) {
     $name = BoincDb::escape_string($name);
     $app = BoincApp::lookup("name='$name'");
@@ -76,6 +82,9 @@ 
     return $y;
 }
 
+/**
+ * @param SimpleXMLElement|null $template
+ */
 function est_elapsed_time($r, $template) {
     // crude estimate: batch FLOPs / project FLOPS
     //
@@ -131,6 +140,9 @@ 
 // The arg is the batch-level template, if any.
 // Jobs may have their own templates.
 //
+/**
+ * @param SimpleXMLElement $template
+ */
 function validate_batch($jobs, $template) {
     $i = 0;
     $n = count($template->file_info);
@@ -200,6 +212,13 @@ 
 
 // submit a list of jobs with a single create_work command.
 //
+/**
+ * @param stdClass $job_params
+ * @param double $priority
+ * @param integer $app_version_num
+ * @param string $input_template_filename
+ * @param string $output_template_filename
+ */
 function submit_jobs(
     $jobs, $job_params, $app, $batch_id, $priority, $app_version_num,
     $input_template_filename,        // batch-level; can also specify per job
@@ -294,6 +313,9 @@ 
 // Check whether the template is already in our map.
 // If not, write it to a temp file.
 //
+/**
+ * @param stdClass $job
+ */
 function make_input_template($job) {
     global $input_templates;
     if (!array_key_exists($job->input_template_xml, $input_templates)) {
@@ -310,6 +332,9 @@ 
 // A little different because these have to exist for life of job.
 // Store them in templates/tmp/, with content-based filenames
 //
+/**
+ * @param stdClass $job
+ */
 function make_output_template($job) {
     global $output_templates;
     if (!array_key_exists($job->output_template_xml, $output_templates)) {
@@ -508,6 +533,9 @@ 
     ";
 }
 
+/**
+ * @param integer $get_cpu_time
+ */
 function print_batch_params($batch, $get_cpu_time) {
     $app = BoincApp::lookup_id($batch->app_id);
     if (!$app) $app->name = "none";