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

// QIM_Type
  • Loading branch information
jgabler-hpc committed Dec 11, 2024
1 parent 233b796 commit 81802f6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 12 deletions.
14 changes: 8 additions & 6 deletions source/libs/sgeobj/cull/sge_mesobj_QIM_L.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,17 @@
#include "sgeobj/cull/sge_boundaries.h"

/**
* @brief @todo add summary
* @brief Queue Instance Message
*
* @todo add description
* Objects of this type hold messages attached to queues (QU_message_list).
* It is also used for ja_task specific messages (JAT_message_list), e.g. job error messages
*
* SGE_ULONG(QIM_type) - @todo add summary
* @todo add description
* SGE_ULONG(QIM_type) - Message Type
* QI states defined in libs/sgeobj/sge_qinstance_state.h, e.g. QI_ERROR, QI_AMBIGUOUS, ...
* Seems to be always 1 for ja_task messages.
*
* SGE_STRING(QIM_message) - @todo add summary
* @todo add description
* SGE_STRING(QIM_message) - Message
* Message as string.
*
*/

Expand Down
14 changes: 8 additions & 6 deletions source/libs/sgeobj/json/QIM.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
{
"className": "QueueInstanceMessage",
"summary": "@todo add summary",
"summary": "Queue Instance Message",
"description": [{
"line": "@todo add description"
"line": "Objects of this type hold messages attached to queues (QU_message_list)."
}, { "line": "It is also used for ja_task specific messages (JAT_message_list), e.g. job error messages"
}],
"cullPrefix": "QIM",
"attributes": [{
"name": "type",
"summary": "@todo add summary",
"summary": "Message Type",
"description": [{
"line": "@todo add description"
"line": "QI states defined in libs/sgeobj/sge_qinstance_state.h, e.g. QI_ERROR, QI_AMBIGUOUS, ..."
}, { "line": "Seems to be always 1 for ja_task messages."
}],
"type": "lUlongT",
"flags": [{
"name": "SPOOL"
}]
}, {
"name": "message",
"summary": "@todo add summary",
"summary": "Message",
"description": [{
"line": "@todo add description"
"line": "Message as string."
}],
"type": "lStringT",
"flags": [{
Expand Down

0 comments on commit 81802f6

Please sign in to comment.