From eaaa1a19caaa32b45ce95dbaa051b55714eebb49 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 7 Aug 2015 11:55:38 -0700 Subject: [PATCH] [JSDoc] Remove obsolete module references WTD-1482 --- platform/commonUI/browse/src/creation/CreateWizard.js | 7 ------- platform/commonUI/edit/src/actions/PropertiesDialog.js | 7 ------- .../edit/src/objects/EditableDomainObjectCache.js | 5 +---- platform/core/src/types/TypeImpl.js | 9 --------- platform/core/src/types/TypeProperty.js | 7 ------- platform/core/src/types/TypePropertyConversion.js | 6 ------ platform/features/events/src/EventListPopulator.js | 5 ++++- platform/features/plot/src/elements/PlotLine.js | 9 +++++++-- platform/representation/src/gestures/GestureConstants.js | 8 ++++++-- 9 files changed, 18 insertions(+), 45 deletions(-) diff --git a/platform/commonUI/browse/src/creation/CreateWizard.js b/platform/commonUI/browse/src/creation/CreateWizard.js index a0e21b102d..bd013f5acc 100644 --- a/platform/commonUI/browse/src/creation/CreateWizard.js +++ b/platform/commonUI/browse/src/creation/CreateWizard.js @@ -21,12 +21,6 @@ *****************************************************************************/ /*global define*/ -/** - * Defines the CreateWizard, used by the CreateAction to - * populate the form shown in dialog based on the created type. - * - * @module core/action/create-wizard - */ define( function () { 'use strict'; @@ -39,7 +33,6 @@ define( * the initial parent for the created object, in the dialog * @memberof platform/commonUI/browse * @constructor - * @memberof module:core/action/create-wizard */ function CreateWizard(type, parent, policyService) { var model = type.getInitialModel(), diff --git a/platform/commonUI/edit/src/actions/PropertiesDialog.js b/platform/commonUI/edit/src/actions/PropertiesDialog.js index 9d7c6ddcb4..a4e3ba1f9f 100644 --- a/platform/commonUI/edit/src/actions/PropertiesDialog.js +++ b/platform/commonUI/edit/src/actions/PropertiesDialog.js @@ -21,12 +21,6 @@ *****************************************************************************/ /*global define*/ -/** - * Defines the PropertiesDialog, used by the PropertiesAction to - * populate the form shown in dialog based on the created type. - * - * @module common/actions/properties-dialog - */ define( function () { 'use strict'; @@ -39,7 +33,6 @@ define( * @param {DomainObject} the object for which properties will be set * @memberof platform/commonUI/edit * @constructor - * @memberof module:common/actions/properties-dialog */ function PropertiesDialog(type, model) { var properties = type.getProperties(); diff --git a/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js b/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js index 9d69a9e364..9fc47ef790 100644 --- a/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js +++ b/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js @@ -22,7 +22,7 @@ /*global define*/ -/** +/* * An editable domain object cache stores domain objects that have been * made editable, in a group that can be saved all-at-once. This supports * Edit mode, which is launched for a specific object but may contain @@ -32,8 +32,6 @@ * to ensure that changes made while in edit mode do not propagate up * to the objects used in browse mode (or to persistence) until the user * initiates a Save. - * - * @module editor/object/editable-domain-object-cache */ define( ["./EditableModelCache"], @@ -53,7 +51,6 @@ define( * @param $q Angular's $q, for promise handling * @memberof platform/commonUI/edit * @constructor - * @memberof module:editor/object/editable-domain-object-cache */ function EditableDomainObjectCache(EditableDomainObject, $q) { var cache = new EditableModelCache(), diff --git a/platform/core/src/types/TypeImpl.js b/platform/core/src/types/TypeImpl.js index 9e5a52d37f..526675e611 100644 --- a/platform/core/src/types/TypeImpl.js +++ b/platform/core/src/types/TypeImpl.js @@ -21,14 +21,6 @@ *****************************************************************************/ /*global define*/ -/** - * Type implementation. Defines a type object which wraps a - * type definition and exposes useful methods for inspecting - * that type and understanding its relationship to other - * types. - * - * @module core/type/type-impl - */ define( ['./TypeProperty'], function (TypeProperty) { @@ -41,7 +33,6 @@ define( * @param {TypeDefinition} typeDef an object containing * key-value pairs describing a type and its * relationship to other types. - * @memberof module:core/type/type-impl * @constructor * @memberof platform/core */ diff --git a/platform/core/src/types/TypeProperty.js b/platform/core/src/types/TypeProperty.js index fb58199c06..2b1cfea0ac 100644 --- a/platform/core/src/types/TypeProperty.js +++ b/platform/core/src/types/TypeProperty.js @@ -21,12 +21,6 @@ *****************************************************************************/ /*global define*/ -/** - * Type property. Defines a mutable or displayable property - * associated with objects of a given type. - * - * @module core/type/type-property - */ define( ['./TypePropertyConversion'], function (TypePropertyConversion) { @@ -38,7 +32,6 @@ define( * * @memberof platform/core * @constructor - * @memberof module:core/type/type-property */ function TypeProperty(propertyDefinition) { // Load an appropriate conversion diff --git a/platform/core/src/types/TypePropertyConversion.js b/platform/core/src/types/TypePropertyConversion.js index d390e74108..56ce1cc5e5 100644 --- a/platform/core/src/types/TypePropertyConversion.js +++ b/platform/core/src/types/TypePropertyConversion.js @@ -21,12 +21,6 @@ *****************************************************************************/ /*global define*/ -/** - * Defines type property conversions, used to convert values from - * a domain object model to values displayable in a form, and - * vice versa. - * @module core/type/type-property-conversion - */ define( function () { 'use strict'; diff --git a/platform/features/events/src/EventListPopulator.js b/platform/features/events/src/EventListPopulator.js index d4e7429d28..f9581e0890 100644 --- a/platform/features/events/src/EventListPopulator.js +++ b/platform/features/events/src/EventListPopulator.js @@ -31,10 +31,11 @@ define( * values which should appear within columns of a event list * view, based on received telemetry data. * @constructor + * @memberof platform/features/events * @param {Column[]} columns the columns to be populated */ function EventListPopulator(columns) { - /** + /* * Look up the most recent values from a set of data objects. * Returns an array of objects in the order in which data * should be displayed; each element is an object with @@ -116,6 +117,7 @@ define( /** * Get the text which should appear in headers for the * provided columns. + * @memberof platform/features/events.EventListPopulator * @returns {string[]} column headers */ getHeaders: function () { @@ -130,6 +132,7 @@ define( * provided the data sets; these should match * index-to-index with the `datas` argument * @param {number} count the number of rows to populate + * @memberof platform/features/events.EventListPopulator * @returns {string[][]} an array of rows, each of which * is an array of values which should appear * in that row diff --git a/platform/features/plot/src/elements/PlotLine.js b/platform/features/plot/src/elements/PlotLine.js index b9d2df3588..ae9b3b56b3 100644 --- a/platform/features/plot/src/elements/PlotLine.js +++ b/platform/features/plot/src/elements/PlotLine.js @@ -27,6 +27,11 @@ define( "use strict"; + /** + * Represents a single line or trace of a plot. + * @param {{PlotLineBuffer}} buffer the plot buffer + * @constructor + */ function PlotLine(buffer) { // Insert a time-windowed data series into the buffer @@ -70,8 +75,7 @@ define( * Add a point to this plot line. * @param {number} domainValue the domain value * @param {number} rangeValue the range value - * @constructor - * @memberof platform/features/plot + * @memberof platform/features/plot.PlotLine */ addPoint: function (domainValue, rangeValue) { var index; @@ -100,6 +104,7 @@ define( * to use when looking up data from this series * @param {string} [range] the key indicating which range * to use when looking up data from this series + * @memberof platform/features/plot.PlotLine */ addSeries: function (series, domain, range) { // Should try to add via insertion if a diff --git a/platform/representation/src/gestures/GestureConstants.js b/platform/representation/src/gestures/GestureConstants.js index 811e942c84..d41fd1b89b 100644 --- a/platform/representation/src/gestures/GestureConstants.js +++ b/platform/representation/src/gestures/GestureConstants.js @@ -22,7 +22,8 @@ /*global define,Promise*/ /** - * Module defining GestureConstants. Created by vwoeltje on 11/17/14. + * Constants used by domain object gestures. + * @class platform/representation.GestureConstants */ define({ /** @@ -30,22 +31,25 @@ define({ * composition of domain objects. (e.g. in event.dataTransfer.setData * calls.) * @constructor - * @memberof platform/representation + * @memberof platform/representation.GestureConstants */ MCT_DRAG_TYPE: 'mct-domain-object-id', /** * The string identifier for the data type used for drag-and-drop * composition of domain objects, by object instance (passed through * the dndService) + * @memberof platform/representation.GestureConstants */ MCT_EXTENDED_DRAG_TYPE: 'mct-domain-object', /** * An estimate for the dimensions of a context menu, used for * positioning. + * @memberof platform/representation.GestureConstants */ MCT_MENU_DIMENSIONS: [ 170, 200 ], /** * Identifier for drop events. + * @memberof platform/representation.GestureConstants */ MCT_DROP_EVENT: 'mctDrop' });