Clarifying comments in checklist-mapper file #6654
Conversation
Signed-off-by: Emily Rodriguez <[email protected]>
| * @extends ChecklistJsonixConverter | ||
| * | ||
| * @property {string | ExecJSON.Execution} data - The input data, which can be a string of XML data or an HDF JSON execution object. | ||
| * @property {Checklist} jsonixData - The JSON representation of the checklist data. |
There was a problem hiding this comment.
I'd revise this statement to explain better that it's like the jsonix, direct conversion of the ckl, js checklist data in comparison to the intermediate representation which cleans it up and makes it easier to use.
| * @property {ChecklistObject} checklistObject - The intermediate object representation of the checklist data. | ||
| * @property {boolean} withRaw - A flag indicating whether to include raw data in the output. | ||
| * | ||
| * @constructor |
There was a problem hiding this comment.
why are we defining the constructor parameters both here and on top of the constructor?
| * @param {string | ExecJSON.Execution} data - The input data, which can be a string of XML data or an HDF JSON execution object. | ||
| * @param {boolean} [withRaw=false] - Optional flag indicating whether to include raw data in the output. | ||
| * | ||
| * @method getJsonix |
There was a problem hiding this comment.
should this info be here or directly on top of the corresponding function?
| * @returns {Checklist} - Returns the JSON representation of the checklist data. | ||
| * | ||
| * @method toCkl | ||
| * @returns {string} - Converts the checklist data to CKL (Checklist) XML format. |
There was a problem hiding this comment.
converts the jsonix json representation of the ckl data into the xml format
| * @returns {string} - Converts the checklist data to CKL (Checklist) XML format. | ||
| * | ||
| * @method toHdf | ||
| * @returns {ExecJSON.Execution} - Converts the checklist data to HDF (Heimdall Data Format). |
There was a problem hiding this comment.
converts the intermediate format ckl data into hdf
Signed-off-by: Emily Rodriguez <[email protected]>
|
There were inaccurate / confusing comments in the checklist mapper. Hopefully this represents the code accurately. Please review and provide feedback.
Is intakeType still used? If so, what is it and how?