EH: CS-40 add documentation comments from old CULL files to the JSON …

…files // PETR_Type
hpc-gridware · Jul 1, 2024 · a546176 · a546176
1 parent afb94b2
commit a546176
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 36 deletions.
diff --git a/source/libs/sgeobj/cull/sge_pe_task_PETR_L.h b/source/libs/sgeobj/cull/sge_pe_task_PETR_L.h
@@ -28,33 +28,34 @@
 #include "sgeobj/cull/sge_boundaries.h"
 
 /**
-* @brief @todo add summary
+* @brief PE Task Request
 *
-* @todo add description
+* Objects of PETR_Type are used to request the start of a task in a
+* tightly integrated parallel job.
 *
-*    SGE_ULONG(PETR_jobid) - @todo add summary
-*    @todo add description
+*    SGE_ULONG(PETR_jobid) - Job ID
+*    Job id of the job to start the task in.
 *
-*    SGE_ULONG(PETR_jataskid) - @todo add summary
-*    @todo add description
+*    SGE_ULONG(PETR_jataskid) - Array Task ID
+*    Array task id of the ja_task to start the pe task in.
 *
-*    SGE_STRING(PETR_queuename) - @todo add summary
-*    @todo add description
+*    SGE_STRING(PETR_queuename) - Queue Name
+*    Optionally: Name of the queue to start the job in.
 *
-*    SGE_STRING(PETR_owner) - @todo add summary
-*    @todo add description
+*    SGE_STRING(PETR_owner) - Owner
+*    Owner of the pe task.
 *
-*    SGE_STRING(PETR_cwd) - @todo add summary
-*    @todo add description
+*    SGE_STRING(PETR_cwd) - Current Working Directory
+*    Current working directory for the execution of the task.
 *
-*    SGE_LIST(PETR_path_aliases) - @todo add summary
-*    @todo add description
+*    SGE_LIST(PETR_path_aliases) - Path Aliases
+*    Optional: Path alias configuration.
 *
-*    SGE_LIST(PETR_environment) - @todo add summary
-*    @todo add description
+*    SGE_LIST(PETR_environment) - Environment
+*    Environment variables to set / to overwrite the job environment with (from qrsh -inherit -v).
 *
-*    SGE_ULONG64(PETR_submission_time) - @todo add summary
-*    ... microseconds since epoch.
+*    SGE_ULONG64(PETR_submission_time) - Submission Time
+*    Time when qrsh -inherit was started in microseconds since epoch.
 *
 */
 

diff --git a/source/libs/sgeobj/json/PETR.json b/source/libs/sgeobj/json/PETR.json
@@ -1,75 +1,77 @@
 {
 	"className":	"PETaskRequest",
-	"summary":	"@todo add summary",
+	"summary":	"PE Task Request",
 	"description":	[{
-			"line":	"@todo add description"
+			"line":	"Objects of PETR_Type are used to request the start of a task in a"
+          }, {
+			"line":	"tightly integrated parallel job."
 		}],
 	"cullPrefix":	"PETR",
 	"attributes":	[{
 			"name":	"jobid",
-			"summary":	"@todo add summary",
+			"summary":	"Job ID",
 			"description":	[{
-					"line":	"@todo add description"
+					"line":	"Job id of the job to start the task in."
 				}],
 			"type":	"lUlongT",
 			"flags":	[]
 		}, {
 			"name":	"jataskid",
-			"summary":	"@todo add summary",
+			"summary":	"Array Task ID",
 			"description":	[{
-					"line":	"@todo add description"
+					"line":	"Array task id of the ja_task to start the pe task in."
 				}],
 			"type":	"lUlongT",
 			"flags":	[]
 		}, {
 			"name":	"queuename",
-			"summary":	"@todo add summary",
+			"summary":	"Queue Name",
 			"description":	[{
-					"line":	"@todo add description"
+					"line":	"Optionally: Name of the queue to start the job in."
 				}],
 			"type":	"lStringT",
 			"flags":	[]
 		}, {
 			"name":	"owner",
-			"summary":	"@todo add summary",
+			"summary":	"Owner",
 			"description":	[{
-					"line":	"@todo add description"
+					"line":	"Owner of the pe task."
 				}],
 			"type":	"lStringT",
 			"flags":	[]
 		}, {
 			"name":	"cwd",
-			"summary":	"@todo add summary",
+			"summary":	"Current Working Directory",
 			"description":	[{
-					"line":	"@todo add description"
+					"line":	"Current working directory for the execution of the task."
 				}],
 			"type":	"lStringT",
 			"flags":	[]
 		}, {
 			"name":	"path_aliases",
-			"summary":	"@todo add summary",
+			"summary":	"Path Aliases",
 			"description":	[{
-					"line":	"@todo add description"
+					"line":	"Optional: Path alias configuration."
 				}],
 			"type":	"lListT",
 			"subClassName":	"PA",
 			"subCullPrefix":	"PA",
 			"flags":	[]
 		}, {
 			"name":	"environment",
-			"summary":	"@todo add summary",
+			"summary":	"Environment",
 			"description":	[{
-					"line":	"@todo add description"
+					"line":	"Environment variables to set / to overwrite the job environment with (from qrsh -inherit -v)."
 				}],
 			"type":	"lListT",
 			"subClassName":	"VA",
 			"subCullPrefix":	"VA",
 			"flags":	[]
 		}, {
 			"name":	"submission_time",
-			"summary":	"@todo add summary",
+			"summary":	"Submission Time",
 			"description":	[{
-					"line":	"... microseconds since epoch."
+					"line":	"Time when qrsh -inherit was started in microseconds since epoch."
 				}],
 			"type":	"lTimestampT",
 			"flags":	[]