Skip to content

Commit

Permalink
EH: CS-40 add documentation comments from old CULL files to the JSON …
Browse files Browse the repository at this point in the history
…files

// JRE_Type
  • Loading branch information
jgabler-hpc committed Jul 12, 2024
1 parent 5301d2d commit 3f81bdb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
13 changes: 7 additions & 6 deletions source/libs/sgeobj/cull/sge_job_ref_JRE_L.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,16 @@
#include "sgeobj/cull/sge_boundaries.h"

/**
* @brief @todo add summary
* @brief Job Reference
*
* @todo add description
* Reference to a job by job id or job name.
* It is for example used to reference successor or predecessor jobs in job dependencies.
*
* SGE_ULONG(JRE_job_number) - @todo add summary
* @todo add description
* SGE_ULONG(JRE_job_number) - Job Number
* Job number of the referenced job.
*
* SGE_STRING(JRE_job_name) - @todo add summary
* @todo add description
* SGE_STRING(JRE_job_name) - Job Name
* Job name of the referenced job(s). Multiple jobs can be referenced by the same name.
*
*/

Expand Down
14 changes: 8 additions & 6 deletions source/libs/sgeobj/json/JRE.json
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
{
"className": "JobReference",
"summary": "@todo add summary",
"summary": "Job Reference",
"description": [{
"line": "@todo add description"
"line": "Reference to a job by job id or job name."
}, {
"line": "It is for example used to reference successor or predecessor jobs in job dependencies."
}],
"cullPrefix": "JRE",
"attributes": [{
"name": "job_number",
"summary": "@todo add summary",
"summary": "Job Number",
"description": [{
"line": "@todo add description"
"line": "Job number of the referenced job."
}],
"type": "lUlongT",
"flags": [{
Expand All @@ -19,9 +21,9 @@
}]
}, {
"name": "job_name",
"summary": "@todo add summary",
"summary": "Job Name",
"description": [{
"line": "@todo add description"
"line": "Job name of the referenced job(s). Multiple jobs can be referenced by the same name."
}],
"type": "lStringT",
"flags": [{
Expand Down

0 comments on commit 3f81bdb

Please sign in to comment.