From 568927995405c3d39d4bc956ddf5eb6931832986 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Thu, 26 May 2016 11:53:16 -0700 Subject: [PATCH] [Timeline] Add JSDoc for idMap https://github.com/nasa/openmct/pull/962#discussion_r64676750 https://github.com/nasa/openmct/pull/962#discussion_r64677198 --- platform/features/timeline/src/actions/CompositionColumn.js | 3 +++ platform/features/timeline/src/actions/IdColumn.js | 5 ++++- platform/features/timeline/src/actions/ModeColumn.js | 3 +++ 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/platform/features/timeline/src/actions/CompositionColumn.js b/platform/features/timeline/src/actions/CompositionColumn.js index 3fff0bda37..e33f028f99 100644 --- a/platform/features/timeline/src/actions/CompositionColumn.js +++ b/platform/features/timeline/src/actions/CompositionColumn.js @@ -27,6 +27,9 @@ define([], function () { * in a domain object's composition. * @param {number} index the zero-based index of the composition * element associated with this column + * @param idMap an object containing key value pairs, where keys + * are domain object identifiers and values are whatever + * should appear in CSV output in their place * @constructor * @implements {platform/features/timeline.TimelineCSVColumn} */ diff --git a/platform/features/timeline/src/actions/IdColumn.js b/platform/features/timeline/src/actions/IdColumn.js index b6ff15fe6c..9148ef6a8b 100644 --- a/platform/features/timeline/src/actions/IdColumn.js +++ b/platform/features/timeline/src/actions/IdColumn.js @@ -23,8 +23,11 @@ define([], function () { /** - * A column showing domain object identifiers. + * A column showing identifying domain objects. * @constructor + * @param idMap an object containing key value pairs, where keys + * are domain object identifiers and values are whatever + * should appear in CSV output in their place * @implements {platform/features/timeline.TimelineCSVColumn} */ function IdColumn(idMap) { diff --git a/platform/features/timeline/src/actions/ModeColumn.js b/platform/features/timeline/src/actions/ModeColumn.js index 26b307cbd0..05eec7a30a 100644 --- a/platform/features/timeline/src/actions/ModeColumn.js +++ b/platform/features/timeline/src/actions/ModeColumn.js @@ -27,6 +27,9 @@ define([], function () { * @constructor * @param {number} index the zero-based index of the composition * element associated with this column + * @param idMap an object containing key value pairs, where keys + * are domain object identifiers and values are whatever + * should appear in CSV output in their place * @implements {platform/features/timeline.TimelineCSVColumn} */ function ModeColumn(index, idMap) {