From c08a460d308439a4d6b8c8667ed2f5b8d3d0805c Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 7 Aug 2015 11:44:54 -0700 Subject: [PATCH] [JSDoc] Add annotations Bulk-add JSDoc annotations, WTD-1482. --- platform/commonUI/about/src/AboutController.js | 5 ++++- platform/commonUI/about/src/LicenseController.js | 4 +++- platform/commonUI/about/src/LogoController.js | 4 +++- platform/commonUI/browse/src/BrowseController.js | 2 ++ .../commonUI/browse/src/BrowseObjectController.js | 2 ++ .../commonUI/browse/src/MenuArrowController.js | 3 ++- .../commonUI/browse/src/creation/CreateAction.js | 5 ++++- .../browse/src/creation/CreateActionProvider.js | 4 +++- .../browse/src/creation/CreateMenuController.js | 3 ++- .../commonUI/browse/src/creation/CreateWizard.js | 7 ++++++- .../browse/src/creation/CreationService.js | 3 +++ .../browse/src/creation/LocatorController.js | 2 ++ .../browse/src/navigation/NavigateAction.js | 4 +++- .../browse/src/navigation/NavigationService.js | 7 ++++++- .../browse/src/windowing/FullscreenAction.js | 5 ++++- .../commonUI/browse/src/windowing/NewTabAction.js | 3 ++- .../commonUI/browse/src/windowing/WindowTitler.js | 3 ++- platform/commonUI/dialog/src/DialogService.js | 5 ++++- platform/commonUI/dialog/src/OverlayService.js | 4 +++- platform/commonUI/edit/src/actions/CancelAction.js | 5 ++++- platform/commonUI/edit/src/actions/EditAction.js | 4 +++- platform/commonUI/edit/src/actions/LinkAction.js | 5 ++++- .../commonUI/edit/src/actions/PropertiesAction.js | 3 +++ .../commonUI/edit/src/actions/PropertiesDialog.js | 6 +++++- platform/commonUI/edit/src/actions/RemoveAction.js | 8 +++++++- platform/commonUI/edit/src/actions/SaveAction.js | 5 ++++- .../capabilities/EditableCompositionCapability.js | 4 +++- .../src/capabilities/EditableContextCapability.js | 4 +++- .../src/capabilities/EditableLookupCapability.js | 4 +++- .../capabilities/EditablePersistenceCapability.js | 4 +++- .../capabilities/EditableRelationshipCapability.js | 4 +++- .../edit/src/capabilities/EditorCapability.js | 7 ++++++- .../edit/src/controllers/EditActionController.js | 3 ++- .../edit/src/controllers/EditController.js | 5 ++++- .../edit/src/controllers/EditPanesController.js | 4 +++- .../edit/src/directives/MCTBeforeUnload.js | 3 ++- .../edit/src/objects/EditableDomainObject.js | 4 +++- .../edit/src/objects/EditableDomainObjectCache.js | 8 ++++++++ .../edit/src/objects/EditableModelCache.js | 4 +++- .../commonUI/edit/src/policies/EditActionPolicy.js | 4 +++- .../edit/src/policies/EditableViewPolicy.js | 4 +++- .../edit/src/representers/EditRepresenter.js | 5 ++++- .../commonUI/edit/src/representers/EditToolbar.js | 6 ++++++ .../src/representers/EditToolbarRepresenter.js | 5 ++++- .../edit/src/representers/EditToolbarSelection.js | 9 ++++++++- platform/commonUI/general/src/StyleSheetLoader.js | 3 ++- .../src/controllers/ActionGroupController.js | 3 ++- .../general/src/controllers/BottomBarController.js | 4 +++- .../general/src/controllers/ClickAwayController.js | 6 +++++- .../src/controllers/ContextMenuController.js | 3 ++- .../src/controllers/GetterSetterController.js | 3 ++- .../general/src/controllers/SelectorController.js | 7 ++++++- .../general/src/controllers/SplitPaneController.js | 6 +++++- .../general/src/controllers/ToggleController.js | 6 +++++- .../general/src/controllers/TreeNodeController.js | 6 +++++- .../src/controllers/ViewSwitcherController.js | 2 ++ .../general/src/directives/MCTContainer.js | 3 ++- .../commonUI/general/src/directives/MCTDrag.js | 2 ++ .../commonUI/general/src/directives/MCTResize.js | 3 ++- .../commonUI/general/src/directives/MCTScroll.js | 3 ++- .../general/src/directives/MCTSplitPane.js | 2 ++ .../commonUI/general/src/directives/MCTSplitter.js | 2 ++ .../commonUI/general/src/services/UrlService.js | 6 +++++- platform/commonUI/inspect/src/InfoConstants.js | 2 +- .../commonUI/inspect/src/gestures/InfoGesture.js | 3 +++ .../commonUI/inspect/src/services/InfoService.js | 3 +++ platform/containment/src/CapabilityTable.js | 5 ++++- platform/containment/src/ComposeActionPolicy.js | 5 ++++- platform/containment/src/CompositionModelPolicy.js | 5 ++++- .../containment/src/CompositionMutabilityPolicy.js | 4 +++- platform/containment/src/CompositionPolicy.js | 5 ++++- platform/containment/src/ContainmentTable.js | 5 ++++- platform/core/src/actions/ActionAggregator.js | 4 +++- platform/core/src/actions/ActionCapability.js | 5 ++++- platform/core/src/actions/ActionProvider.js | 4 +++- .../core/src/actions/LoggingActionDecorator.js | 4 +++- .../core/src/capabilities/CompositionCapability.js | 4 +++- .../core/src/capabilities/ContextCapability.js | 6 +++++- .../src/capabilities/ContextualDomainObject.js | 3 ++- .../src/capabilities/CoreCapabilityProvider.js | 3 +++ .../core/src/capabilities/DelegationCapability.js | 5 ++++- .../core/src/capabilities/MetadataCapability.js | 4 ++++ .../core/src/capabilities/MutationCapability.js | 5 +++++ .../core/src/capabilities/PersistenceCapability.js | 6 +++++- .../src/capabilities/RelationshipCapability.js | 5 ++++- platform/core/src/models/CachingModelDecorator.js | 4 +++- platform/core/src/models/MissingModelDecorator.js | 3 +++ platform/core/src/models/ModelAggregator.js | 4 +++- platform/core/src/models/PersistedModelProvider.js | 4 +++- platform/core/src/models/RootModelProvider.js | 4 +++- platform/core/src/models/StaticModelProvider.js | 4 +++- platform/core/src/objects/DomainObject.js | 8 +++++++- platform/core/src/objects/DomainObjectProvider.js | 4 +++- platform/core/src/services/Now.js | 5 ++++- platform/core/src/services/Throttle.js | 4 ++++ platform/core/src/services/Topic.js | 4 ++++ platform/core/src/types/MergeModels.js | 4 +++- platform/core/src/types/TypeCapability.js | 3 ++- platform/core/src/types/TypeImpl.js | 13 ++++++++++++- platform/core/src/types/TypeProperty.js | 6 +++++- platform/core/src/types/TypePropertyConversion.js | 4 +++- platform/core/src/types/TypeProvider.js | 5 ++++- platform/core/src/views/ViewCapability.js | 4 +++- platform/core/src/views/ViewProvider.js | 4 +++- platform/entanglement/src/actions/CopyAction.js | 3 +++ platform/entanglement/src/actions/LinkAction.js | 3 +++ platform/entanglement/src/actions/MoveAction.js | 3 +++ platform/entanglement/src/services/CopyService.js | 6 ++++++ platform/entanglement/src/services/LinkService.js | 5 +++++ .../entanglement/src/services/LocationService.js | 4 ++++ platform/entanglement/src/services/MoveService.js | 5 +++++ platform/execution/src/WorkerService.js | 3 +++ platform/features/events/src/DomainColumn.js | 5 ++++- .../features/events/src/EventListController.js | 2 ++ platform/features/events/src/EventListPopulator.js | 2 +- platform/features/events/src/RangeColumn.js | 5 ++++- .../features/events/src/directives/MCTDataTable.js | 2 +- .../events/src/policies/MessagesViewPolicy.js | 4 +++- .../imagery/src/controllers/ImageryController.js | 8 ++++++++ .../imagery/src/directives/MCTBackgroundImage.js | 3 +++ .../imagery/src/policies/ImageryViewPolicy.js | 3 +++ platform/features/layout/src/FixedController.js | 9 +++++++++ platform/features/layout/src/FixedDragHandle.js | 7 ++++++- platform/features/layout/src/FixedProxy.js | 4 +++- .../features/layout/src/LayoutCompositionPolicy.js | 4 ++++ platform/features/layout/src/LayoutController.js | 6 ++++++ platform/features/layout/src/LayoutDrag.js | 5 ++++- .../layout/src/elements/AccessorMutator.js | 3 ++- platform/features/layout/src/elements/BoxProxy.js | 4 +++- .../features/layout/src/elements/ElementFactory.js | 4 +++- .../features/layout/src/elements/ElementProxies.js | 2 +- .../features/layout/src/elements/ElementProxy.js | 12 +++++++++++- .../features/layout/src/elements/ImageProxy.js | 4 +++- .../features/layout/src/elements/LineHandle.js | 5 ++++- platform/features/layout/src/elements/LineProxy.js | 12 +++++++++++- .../features/layout/src/elements/ResizeHandle.js | 5 ++++- .../features/layout/src/elements/TelemetryProxy.js | 3 ++- platform/features/layout/src/elements/TextProxy.js | 5 ++++- .../features/pages/src/EmbeddedPageController.js | 5 ++++- platform/features/plot/src/Canvas2DChart.js | 7 ++++++- platform/features/plot/src/GLChart.js | 7 ++++++- platform/features/plot/src/MCTChart.js | 2 ++ platform/features/plot/src/PlotController.js | 13 +++++++++++++ platform/features/plot/src/SubPlot.js | 14 ++++++++++++++ platform/features/plot/src/SubPlotFactory.js | 4 +++- platform/features/plot/src/elements/PlotAxis.js | 5 ++++- .../features/plot/src/elements/PlotLimitTracker.js | 3 ++- platform/features/plot/src/elements/PlotLine.js | 4 +++- .../features/plot/src/elements/PlotLineBuffer.js | 10 ++++++++++ platform/features/plot/src/elements/PlotPalette.js | 3 ++- .../features/plot/src/elements/PlotPanZoomStack.js | 11 ++++++++++- .../plot/src/elements/PlotPanZoomStackGroup.js | 8 +++++++- .../features/plot/src/elements/PlotPosition.js | 6 +++++- .../features/plot/src/elements/PlotPreparer.js | 7 ++++++- .../features/plot/src/elements/PlotSeriesWindow.js | 4 +++- .../plot/src/elements/PlotTickGenerator.js | 5 ++++- platform/features/plot/src/elements/PlotUpdater.js | 8 ++++++++ .../features/plot/src/modes/PlotModeOptions.js | 7 ++++++- .../features/plot/src/modes/PlotOverlayMode.js | 7 ++++++- platform/features/plot/src/modes/PlotStackMode.js | 8 +++++++- .../features/plot/src/policies/PlotViewPolicy.js | 3 +++ platform/features/rtevents/src/DomainColumn.js | 4 ++++ .../features/rtevents/src/RTEventListController.js | 2 ++ platform/features/rtevents/src/RangeColumn.js | 4 ++++ .../rtevents/src/directives/MCTRTDataTable.js | 2 +- .../rtevents/src/policies/RTMessagesViewPolicy.js | 4 +++- platform/features/rtscrolling/src/DomainColumn.js | 4 ++++ platform/features/rtscrolling/src/NameColumn.js | 4 ++++ .../rtscrolling/src/RTScrollingListController.js | 2 ++ platform/features/rtscrolling/src/RangeColumn.js | 4 ++++ platform/features/scrolling/src/DomainColumn.js | 5 ++++- platform/features/scrolling/src/NameColumn.js | 5 ++++- platform/features/scrolling/src/RangeColumn.js | 5 ++++- .../scrolling/src/ScrollingListController.js | 2 ++ .../scrolling/src/ScrollingListPopulator.js | 5 +++++ platform/forms/src/MCTControl.js | 4 +++- platform/forms/src/MCTForm.js | 3 ++- platform/forms/src/MCTToolbar.js | 3 ++- platform/forms/src/controllers/ColorController.js | 2 +- .../forms/src/controllers/CompositeController.js | 4 +++- .../forms/src/controllers/DateTimeController.js | 2 ++ .../src/controllers/DialogButtonController.js | 4 +++- platform/forms/src/controllers/FormController.js | 3 ++- platform/framework/src/Constants.js | 2 +- platform/framework/src/FrameworkInitializer.js | 3 ++- platform/framework/src/LogLevel.js | 4 +++- platform/framework/src/Main.js | 2 +- .../src/bootstrap/ApplicationBootstrapper.js | 4 +++- platform/framework/src/load/Bundle.js | 13 ++++++++++++- platform/framework/src/load/BundleLoader.js | 4 +++- platform/framework/src/load/Extension.js | 11 ++++++++++- .../framework/src/register/CustomRegistrars.js | 3 ++- .../framework/src/register/ExtensionRegistrar.js | 4 +++- platform/framework/src/register/ExtensionSorter.js | 4 +++- .../framework/src/register/PartialConstructor.js | 3 ++- .../framework/src/register/ServiceCompositor.js | 4 +++- platform/framework/src/resolve/BundleResolver.js | 5 ++++- .../framework/src/resolve/ExtensionResolver.js | 4 +++- .../framework/src/resolve/ImplementationLoader.js | 4 +++- .../framework/src/resolve/RequireConfigurator.js | 4 +++- .../cache/src/CachingPersistenceDecorator.js | 9 ++++++++- platform/persistence/couch/src/CouchDocument.js | 3 ++- platform/persistence/couch/src/CouchIndicator.js | 8 +++++++- .../couch/src/CouchPersistenceProvider.js | 9 ++++++++- .../persistence/elastic/src/ElasticIndicator.js | 8 +++++++- .../elastic/src/ElasticPersistenceProvider.js | 9 ++++++++- .../queue/src/PersistenceFailureConstants.js | 2 +- .../queue/src/PersistenceFailureController.js | 6 +++++- .../queue/src/PersistenceFailureDialog.js | 4 +++- .../queue/src/PersistenceFailureHandler.js | 4 +++- platform/persistence/queue/src/PersistenceQueue.js | 4 +++- .../queue/src/PersistenceQueueHandler.js | 5 ++++- .../persistence/queue/src/PersistenceQueueImpl.js | 5 ++++- .../queue/src/QueuingPersistenceCapability.js | 4 +++- .../src/QueuingPersistenceCapabilityDecorator.js | 4 +++- platform/policy/src/PolicyActionDecorator.js | 5 ++++- platform/policy/src/PolicyProvider.js | 4 +++- platform/policy/src/PolicyViewDecorator.js | 5 ++++- platform/representation/src/MCTInclude.js | 2 ++ platform/representation/src/MCTRepresentation.js | 2 ++ .../src/actions/ContextMenuAction.js | 3 ++- .../src/gestures/ContextMenuGesture.js | 4 +++- .../representation/src/gestures/DragGesture.js | 4 +++- .../representation/src/gestures/DropGesture.js | 4 +++- .../src/gestures/GestureConstants.js | 4 +++- .../representation/src/gestures/GestureProvider.js | 4 +++- .../src/gestures/GestureRepresenter.js | 6 +++++- platform/representation/src/services/DndService.js | 6 +++++- platform/telemetry/src/TelemetryAggregator.js | 5 ++++- platform/telemetry/src/TelemetryCapability.js | 5 +++++ platform/telemetry/src/TelemetryController.js | 9 ++++++++- platform/telemetry/src/TelemetryDelegator.js | 5 ++++- platform/telemetry/src/TelemetryFormatter.js | 5 ++++- platform/telemetry/src/TelemetryHandle.js | 6 +++++- platform/telemetry/src/TelemetryHandler.js | 3 ++- platform/telemetry/src/TelemetryQueue.js | 6 +++++- platform/telemetry/src/TelemetrySubscriber.js | 4 +++- platform/telemetry/src/TelemetrySubscription.js | 9 +++++++++ platform/telemetry/src/TelemetryTable.js | 6 +++++- 239 files changed, 939 insertions(+), 185 deletions(-) diff --git a/platform/commonUI/about/src/AboutController.js b/platform/commonUI/about/src/AboutController.js index 7fc61c8cc2..b2fce0bdfd 100644 --- a/platform/commonUI/about/src/AboutController.js +++ b/platform/commonUI/about/src/AboutController.js @@ -29,6 +29,7 @@ define( /** * The AboutController provides information to populate the * About dialog. + * @memberof platform/commonUI/about * @constructor * @param {object[]} versions an array of version extensions; * injected from `versions[]` @@ -42,6 +43,7 @@ define( * as a line-item in the version information listing. * @memberof AboutController# * @returns {object[]} version information + * @memberof platform/commonUI/about.AboutController# */ versions: function () { return versions; @@ -50,6 +52,7 @@ define( * Open a new window (or tab, depending on browser * configuration) containing open source licenses. * @memberof AboutController# + * @memberof platform/commonUI/about.AboutController# */ openLicenses: function () { // Open a new browser window at the licenses route @@ -60,4 +63,4 @@ define( return AboutController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/about/src/LicenseController.js b/platform/commonUI/about/src/LicenseController.js index 1d996596aa..a2e7463b37 100644 --- a/platform/commonUI/about/src/LicenseController.js +++ b/platform/commonUI/about/src/LicenseController.js @@ -29,6 +29,7 @@ define( /** * Provides extension-introduced licenses information to the * licenses route. + * @memberof platform/commonUI/about * @constructor */ function LicenseController(licenses) { @@ -36,6 +37,7 @@ define( /** * Get license information. * @returns {Array} license extensions + * @memberof platform/commonUI/about.LicenseController# */ licenses: function () { return licenses; @@ -45,4 +47,4 @@ define( return LicenseController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/about/src/LogoController.js b/platform/commonUI/about/src/LogoController.js index a688e96acf..f151900df5 100644 --- a/platform/commonUI/about/src/LogoController.js +++ b/platform/commonUI/about/src/LogoController.js @@ -29,6 +29,7 @@ define( /** * The LogoController provides functionality to the application * logo in the bottom-right of the user interface. + * @memberof platform/commonUI/about * @constructor * @param {OverlayService} overlayService the overlay service */ @@ -37,6 +38,7 @@ define( /** * Display the About dialog. * @memberof LogoController# + * @memberof platform/commonUI/about.LogoController# */ showAboutDialog: function () { overlayService.createOverlay("overlay-about"); @@ -46,4 +48,4 @@ define( return LogoController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/BrowseController.js b/platform/commonUI/browse/src/BrowseController.js index 3ec38057fc..7d65db507d 100644 --- a/platform/commonUI/browse/src/BrowseController.js +++ b/platform/commonUI/browse/src/BrowseController.js @@ -39,6 +39,7 @@ define( * which Angular templates first have access to the domain object * hierarchy. * + * @memberof platform/commonUI/browse * @constructor */ function BrowseController($scope, $route, $location, objectService, navigationService, urlService) { @@ -157,3 +158,4 @@ define( return BrowseController; } ); + diff --git a/platform/commonUI/browse/src/BrowseObjectController.js b/platform/commonUI/browse/src/BrowseObjectController.js index 1826120458..b1af9f29a7 100644 --- a/platform/commonUI/browse/src/BrowseObjectController.js +++ b/platform/commonUI/browse/src/BrowseObjectController.js @@ -29,6 +29,7 @@ define( /** * Controller for the `browse-object` representation of a domain * object (the right-hand side of Browse mode.) + * @memberof platform/commonUI/browse * @constructor */ function BrowseObjectController($scope, $location, $route) { @@ -71,3 +72,4 @@ define( return BrowseObjectController; } ); + diff --git a/platform/commonUI/browse/src/MenuArrowController.js b/platform/commonUI/browse/src/MenuArrowController.js index 86cad25c0e..f3894df03c 100644 --- a/platform/commonUI/browse/src/MenuArrowController.js +++ b/platform/commonUI/browse/src/MenuArrowController.js @@ -33,6 +33,7 @@ define( * A left-click on the menu arrow should display a * context menu. This controller launches the context * menu. + * @memberof platform/commonUI/browse * @constructor */ function MenuArrowController($scope) { @@ -48,4 +49,4 @@ define( return MenuArrowController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/creation/CreateAction.js b/platform/commonUI/browse/src/creation/CreateAction.js index ce0d6d5cd4..e30ff06d05 100644 --- a/platform/commonUI/browse/src/creation/CreateAction.js +++ b/platform/commonUI/browse/src/creation/CreateAction.js @@ -34,6 +34,7 @@ define( * domain objects of a specific type. This is the action that * is performed when a user uses the Create menu. * + * @memberof platform/commonUI/browse * @constructor * @param {Type} type the type of domain object to create * @param {DomainObject} parent the domain object that should @@ -95,6 +96,7 @@ define( * This will prompt for user input first. * @method * @memberof CreateAction + * @memberof platform/commonUI/browse.CreateAction# */ perform: perform, @@ -107,6 +109,7 @@ define( * * `context`: The context in which this action will be performed. * * @return {object} metadata about the create action + * @memberof platform/commonUI/browse.CreateAction# */ getMetadata: function () { return { @@ -123,4 +126,4 @@ define( return CreateAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/creation/CreateActionProvider.js b/platform/commonUI/browse/src/creation/CreateActionProvider.js index dcc98b8e95..1078089d3f 100644 --- a/platform/commonUI/browse/src/creation/CreateActionProvider.js +++ b/platform/commonUI/browse/src/creation/CreateActionProvider.js @@ -33,6 +33,7 @@ define( * The CreateActionProvider is an ActionProvider which introduces * a Create action for each creatable domain object type. * + * @memberof platform/commonUI/browse * @constructor * @param {TypeService} typeService the type service, used to discover * available types @@ -51,6 +52,7 @@ define( * @memberof CreateActionProvider * @method * @returns {CreateAction[]} + * @memberof platform/commonUI/browse.CreateActionProvider# */ getActions: function (actionContext) { var context = actionContext || {}, @@ -84,4 +86,4 @@ define( return CreateActionProvider; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/creation/CreateMenuController.js b/platform/commonUI/browse/src/creation/CreateMenuController.js index 2dace415df..624764c2e4 100644 --- a/platform/commonUI/browse/src/creation/CreateMenuController.js +++ b/platform/commonUI/browse/src/creation/CreateMenuController.js @@ -34,6 +34,7 @@ define( * set of Create actions based on the currently-selected * domain object. * + * @memberof platform/commonUI/browse * @constructor */ function CreateMenuController($scope) { @@ -55,4 +56,4 @@ define( return CreateMenuController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/creation/CreateWizard.js b/platform/commonUI/browse/src/creation/CreateWizard.js index 29fe953e18..a0e21b102d 100644 --- a/platform/commonUI/browse/src/creation/CreateWizard.js +++ b/platform/commonUI/browse/src/creation/CreateWizard.js @@ -37,6 +37,7 @@ define( * @param {TypeImpl} type the type of domain object to be created * @param {DomainObject} parent the domain object to serve as * the initial parent for the created object, in the dialog + * @memberof platform/commonUI/browse * @constructor * @memberof module:core/action/create-wizard */ @@ -62,6 +63,7 @@ define( * * @return {FormModel} formModel the form model to * show in the create dialog + * @memberof platform/commonUI/browse.CreateWizard# */ getFormStructure: function () { var sections = []; @@ -100,6 +102,7 @@ define( * in the structure. * * @returns {object} the initial value of the form + * @memberof platform/commonUI/browse.CreateWizard# */ getInitialFormValue: function () { // Start with initial values for properties @@ -116,6 +119,7 @@ define( * Based on a populated form, get the domain object which * should be used as a parent for the newly-created object. * @return {DomainObject} + * @memberof platform/commonUI/browse.CreateWizard# */ getLocation: function (formValue) { return formValue.createParent || parent; @@ -124,6 +128,7 @@ define( * Create the domain object model for a newly-created object, * based on user input read from a formModel. * @return {object} the domain object' model + * @memberof platform/commonUI/browse.CreateWizard# */ createModel: function (formValue) { // Clone @@ -146,4 +151,4 @@ define( return CreateWizard; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/creation/CreationService.js b/platform/commonUI/browse/src/creation/CreationService.js index 015573c8bd..a4dffdd8e4 100644 --- a/platform/commonUI/browse/src/creation/CreationService.js +++ b/platform/commonUI/browse/src/creation/CreationService.js @@ -39,6 +39,7 @@ define( * persisting new domain objects. Handles all actual object * mutation and persistence associated with domain object * creation. + * @memberof platform/commonUI/browse * @constructor */ function CreationService(persistenceService, $q, $log) { @@ -131,6 +132,7 @@ define( * @param {DomainObject} parent the domain object which * should contain the newly-created domain object * in its composition + * @memberof platform/commonUI/browse.CreationService# */ createObject: createObject }; @@ -139,3 +141,4 @@ define( return CreationService; } ); + diff --git a/platform/commonUI/browse/src/creation/LocatorController.js b/platform/commonUI/browse/src/creation/LocatorController.js index c7104956ea..d6335f9bd1 100644 --- a/platform/commonUI/browse/src/creation/LocatorController.js +++ b/platform/commonUI/browse/src/creation/LocatorController.js @@ -30,6 +30,7 @@ define( * Controller for the "locator" control, which provides the * user with the ability to select a domain object as the * destination for a newly-created object in the Create menu. + * @memberof platform/commonUI/browse * @constructor */ function LocatorController($scope) { @@ -79,3 +80,4 @@ define( return LocatorController; } ); + diff --git a/platform/commonUI/browse/src/navigation/NavigateAction.js b/platform/commonUI/browse/src/navigation/NavigateAction.js index 779a83044a..04ada63690 100644 --- a/platform/commonUI/browse/src/navigation/NavigateAction.js +++ b/platform/commonUI/browse/src/navigation/NavigateAction.js @@ -31,6 +31,7 @@ define( /** * The navigate action navigates to a specific domain object. + * @memberof platform/commonUI/browse * @constructor */ function NavigateAction(navigationService, $q, context) { @@ -46,6 +47,7 @@ define( * Navigate to the object described in the context. * @returns {Promise} a promise that is resolved once the * navigation has been updated + * @memberof platform/commonUI/browse.NavigateAction# */ perform: perform }; @@ -64,4 +66,4 @@ define( return NavigateAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/navigation/NavigationService.js b/platform/commonUI/browse/src/navigation/NavigationService.js index c8c76857b8..cd2ab1b206 100644 --- a/platform/commonUI/browse/src/navigation/NavigationService.js +++ b/platform/commonUI/browse/src/navigation/NavigationService.js @@ -32,6 +32,7 @@ define( /** * The navigation service maintains the application's current * navigation state, and allows listening for changes thereto. + * @memberof platform/commonUI/browse * @constructor */ function NavigationService() { @@ -68,12 +69,14 @@ define( return { /** * Get the current navigation state. + * @memberof platform/commonUI/browse.NavigationService# */ getNavigation: getNavigation, /** * Set the current navigation state. Thiswill invoke listeners. * @param {DomainObject} value the domain object to navigate * to + * @memberof platform/commonUI/browse.NavigationService# */ setNavigation: setNavigation, /** @@ -82,6 +85,7 @@ define( * this changes. * @param {function} callback the callback to invoke when * navigation state changes + * @memberof platform/commonUI/browse.NavigationService# */ addListener: addListener, /** @@ -89,6 +93,7 @@ define( * @param {function} callback the callback which should * no longer be invoked when navigation state * changes + * @memberof platform/commonUI/browse.NavigationService# */ removeListener: removeListener }; @@ -96,4 +101,4 @@ define( return NavigationService; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/windowing/FullscreenAction.js b/platform/commonUI/browse/src/windowing/FullscreenAction.js index efba99520b..cea492f892 100644 --- a/platform/commonUI/browse/src/windowing/FullscreenAction.js +++ b/platform/commonUI/browse/src/windowing/FullscreenAction.js @@ -35,12 +35,14 @@ define( /** * The fullscreen action toggles between fullscreen display * and regular in-window display. + * @memberof platform/commonUI/browse * @constructor */ function FullscreenAction(context) { return { /** * Toggle full screen state + * @memberof platform/commonUI/browse.FullscreenAction# */ perform: function () { screenfull.toggle(); @@ -48,6 +50,7 @@ define( /** * Get metadata about this action, including the * applicable glyph to display. + * @memberof platform/commonUI/browse.FullscreenAction# */ getMetadata: function () { // We override getMetadata, because the glyph and @@ -67,4 +70,4 @@ define( return FullscreenAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/windowing/NewTabAction.js b/platform/commonUI/browse/src/windowing/NewTabAction.js index 8616a89711..8d38f994e2 100644 --- a/platform/commonUI/browse/src/windowing/NewTabAction.js +++ b/platform/commonUI/browse/src/windowing/NewTabAction.js @@ -33,6 +33,7 @@ define( /** * The new tab action allows a domain object to be opened * into a new browser tab. + * @memberof platform/commonUI/browse * @constructor */ function NewTabAction(urlService, $window, context) { @@ -64,4 +65,4 @@ define( return NewTabAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/browse/src/windowing/WindowTitler.js b/platform/commonUI/browse/src/windowing/WindowTitler.js index 9db65e5b0e..4ce448cb1e 100644 --- a/platform/commonUI/browse/src/windowing/WindowTitler.js +++ b/platform/commonUI/browse/src/windowing/WindowTitler.js @@ -29,6 +29,7 @@ define( /** * Updates the title of the current window to reflect the name * of the currently navigated-to domain object. + * @memberof platform/commonUI/browse * @constructor */ function WindowTitler(navigationService, $rootScope, $document) { @@ -49,4 +50,4 @@ define( return WindowTitler; } -); \ No newline at end of file +); diff --git a/platform/commonUI/dialog/src/DialogService.js b/platform/commonUI/dialog/src/DialogService.js index d0c2c83f42..a435d287e5 100644 --- a/platform/commonUI/dialog/src/DialogService.js +++ b/platform/commonUI/dialog/src/DialogService.js @@ -32,6 +32,7 @@ define( * The dialog service is responsible for handling window-modal * communication with the user, such as displaying forms for user * input. + * @memberof platform/commonUI/dialog * @constructor */ function DialogService(overlayService, $q, $log) { @@ -142,6 +143,7 @@ define( * user has supplied; this may be rejected if * user input cannot be obtained (for instance, * because the user cancelled the dialog) + * @memberof platform/commonUI/dialog.DialogService# */ getUserInput: getUserInput, /** @@ -149,6 +151,7 @@ define( * which will be shown as buttons. * * @param dialogModel a description of the dialog to show + * @memberof platform/commonUI/dialog.DialogService# */ getUserChoice: getUserChoice }; @@ -156,4 +159,4 @@ define( return DialogService; } -); \ No newline at end of file +); diff --git a/platform/commonUI/dialog/src/OverlayService.js b/platform/commonUI/dialog/src/OverlayService.js index b66bffa7dc..4611a96148 100644 --- a/platform/commonUI/dialog/src/OverlayService.js +++ b/platform/commonUI/dialog/src/OverlayService.js @@ -43,6 +43,7 @@ define( * particularly where a multiple-overlay effect is not specifically * desired). * + * @memberof platform/commonUI/dialog * @constructor */ function OverlayService($document, $compile, $rootScope) { @@ -89,6 +90,7 @@ define( * @param {object} overlayModel the model to pass to the * included overlay template (this will be passed * in via ng-model) + * @memberof platform/commonUI/dialog.OverlayService# */ createOverlay: createOverlay }; @@ -96,4 +98,4 @@ define( return OverlayService; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/actions/CancelAction.js b/platform/commonUI/edit/src/actions/CancelAction.js index 725f6ee6a7..7b2f28538d 100644 --- a/platform/commonUI/edit/src/actions/CancelAction.js +++ b/platform/commonUI/edit/src/actions/CancelAction.js @@ -29,6 +29,8 @@ define( * The "Cancel" action; the action triggered by clicking Cancel from * Edit Mode. Exits the editing user interface and invokes object * capabilities to persist the changes that have been made. + * @constructor + * @memberof platform/commonUI/edit */ function CancelAction($location, urlService, context) { var domainObject = context.domainObject; @@ -62,6 +64,7 @@ define( * * @returns {Promise} a promise that will be fulfilled when * cancellation has completed + * @memberof platform/commonUI/edit.CancelAction# */ perform: function () { return doCancel(getEditorCapability()) @@ -84,4 +87,4 @@ define( return CancelAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/actions/EditAction.js b/platform/commonUI/edit/src/actions/EditAction.js index 38260469ae..2559d0488d 100644 --- a/platform/commonUI/edit/src/actions/EditAction.js +++ b/platform/commonUI/edit/src/actions/EditAction.js @@ -42,6 +42,7 @@ define( * mode (typically triggered by the Edit button.) This will * show the user interface for editing (by way of a change in * route) + * @memberof platform/commonUI/edit * @constructor */ function EditAction($location, navigationService, $log, context) { @@ -63,6 +64,7 @@ define( return { /** * Enter edit mode. + * @memberof platform/commonUI/edit.EditAction# */ perform: function () { navigationService.setNavigation(domainObject); @@ -87,4 +89,4 @@ define( return EditAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/actions/LinkAction.js b/platform/commonUI/edit/src/actions/LinkAction.js index f7d0087646..b0c2e35e31 100644 --- a/platform/commonUI/edit/src/actions/LinkAction.js +++ b/platform/commonUI/edit/src/actions/LinkAction.js @@ -29,6 +29,8 @@ define( /** * Add one domain object to another's composition. + * @constructor + * @memberof platform/commonUI/edit */ function LinkAction(context) { var domainObject = (context || {}).domainObject, @@ -58,6 +60,7 @@ define( return { /** * Perform this action. + * @memberof platform/commonUI/edit.LinkAction# */ perform: function () { return selectedId && doLink(); @@ -67,4 +70,4 @@ define( return LinkAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/actions/PropertiesAction.js b/platform/commonUI/edit/src/actions/PropertiesAction.js index bb37727c0e..0cab34a879 100644 --- a/platform/commonUI/edit/src/actions/PropertiesAction.js +++ b/platform/commonUI/edit/src/actions/PropertiesAction.js @@ -38,6 +38,7 @@ define( * @param {DialogService} dialogService a service which will show the dialog * @param {DomainObject} object the object to be edited * @param {ActionContext} context the context in which this action is performed + * @memberof platform/commonUI/edit * @constructor */ function PropertiesAction(dialogService, context) { @@ -77,6 +78,7 @@ define( * Perform this action. * @return {Promise} a promise which will be * fulfilled when the action has completed. + * @memberof platform/commonUI/edit.PropertiesAction# */ perform: function () { var type = object.getCapability('type'); @@ -106,3 +108,4 @@ define( ); + diff --git a/platform/commonUI/edit/src/actions/PropertiesDialog.js b/platform/commonUI/edit/src/actions/PropertiesDialog.js index 8319efc315..9d7c6ddcb4 100644 --- a/platform/commonUI/edit/src/actions/PropertiesDialog.js +++ b/platform/commonUI/edit/src/actions/PropertiesDialog.js @@ -37,6 +37,7 @@ define( * @param {TypeImpl} type the type of domain object for which properties * will be specified * @param {DomainObject} the object for which properties will be set + * @memberof platform/commonUI/edit * @constructor * @memberof module:common/actions/properties-dialog */ @@ -47,6 +48,7 @@ define( /** * Get sections provided by this dialog. * @return {FormStructure} the structure of this form + * @memberof platform/commonUI/edit.PropertiesDialog# */ getFormStructure: function () { return { @@ -66,6 +68,7 @@ define( * Get the initial state of the form shown by this dialog * (based on the object model) * @returns {object} initial state of the form + * @memberof platform/commonUI/edit.PropertiesDialog# */ getInitialFormValue: function () { // Start with initial values for properties @@ -77,6 +80,7 @@ define( }, /** * Update a domain object model based on the value of a form. + * @memberof platform/commonUI/edit.PropertiesDialog# */ updateModel: function (model, formValue) { // Update all properties @@ -91,4 +95,4 @@ define( return PropertiesDialog; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/actions/RemoveAction.js b/platform/commonUI/edit/src/actions/RemoveAction.js index fbf47d22d9..b19dff31a2 100644 --- a/platform/commonUI/edit/src/actions/RemoveAction.js +++ b/platform/commonUI/edit/src/actions/RemoveAction.js @@ -37,6 +37,7 @@ define( * * @param {DomainObject} object the object to be removed * @param {ActionContext} context the context in which this action is performed + * @memberof platform/commonUI/edit * @constructor * @memberof module:editor/actions/remove-action */ @@ -47,6 +48,7 @@ define( * Check whether an object ID matches the ID of the object being * removed (used to filter a parent's composition to handle the * removal.) + * @memberof platform/commonUI/edit.RemoveAction# */ function isNotObject(otherObjectId) { return otherObjectId !== object.getId(); @@ -55,6 +57,7 @@ define( /** * Mutate a parent object such that it no longer contains the object * which is being removed. + * @memberof platform/commonUI/edit.RemoveAction# */ function doMutate(model) { model.composition = model.composition.filter(isNotObject); @@ -63,6 +66,7 @@ define( /** * Invoke persistence on a domain object. This will be called upon * the removed object's parent (as its composition will have changed.) + * @memberof platform/commonUI/edit.RemoveAction# */ function doPersist(domainObject) { var persistence = domainObject.getCapability('persistence'); @@ -74,6 +78,7 @@ define( * capability. * @param {ContextCapability} contextCapability the "context" capability * of the domain object being removed. + * @memberof platform/commonUI/edit.RemoveAction# */ function removeFromContext(contextCapability) { var parent = contextCapability.getParent(); @@ -89,6 +94,7 @@ define( * Perform this action. * @return {module:core/promises.Promise} a promise which will be * fulfilled when the action has completed. + * @memberof platform/commonUI/edit.RemoveAction# */ perform: function () { return $q.when(object.getCapability('context')) @@ -113,4 +119,4 @@ define( return RemoveAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/actions/SaveAction.js b/platform/commonUI/edit/src/actions/SaveAction.js index d5db593742..428f825837 100644 --- a/platform/commonUI/edit/src/actions/SaveAction.js +++ b/platform/commonUI/edit/src/actions/SaveAction.js @@ -30,6 +30,8 @@ define( * The "Save" action; the action triggered by clicking Save from * Edit Mode. Exits the editing user interface and invokes object * capabilities to persist the changes that have been made. + * @constructor + * @memberof platform/commonUI/edit */ function SaveAction($location, urlService, context) { var domainObject = context.domainObject; @@ -57,6 +59,7 @@ define( * * @returns {Promise} a promise that will be fulfilled when * cancellation has completed + * @memberof platform/commonUI/edit.SaveAction# */ perform: function () { return doSave().then(returnToBrowse); @@ -78,4 +81,4 @@ define( return SaveAction; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/capabilities/EditableCompositionCapability.js b/platform/commonUI/edit/src/capabilities/EditableCompositionCapability.js index 02276639d2..462a95ec18 100644 --- a/platform/commonUI/edit/src/capabilities/EditableCompositionCapability.js +++ b/platform/commonUI/edit/src/capabilities/EditableCompositionCapability.js @@ -35,6 +35,8 @@ define( * Meant specifically for use by EditableDomainObject and the * associated cache; the constructor signature is particular * to a pattern used there and may contain unused arguments. + * @constructor + * @memberof platform/commonUI/edit */ return function EditableCompositionCapability( contextCapability, @@ -54,4 +56,4 @@ define( ); }; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/capabilities/EditableContextCapability.js b/platform/commonUI/edit/src/capabilities/EditableContextCapability.js index 34ea3ee465..3d61bdd8a3 100644 --- a/platform/commonUI/edit/src/capabilities/EditableContextCapability.js +++ b/platform/commonUI/edit/src/capabilities/EditableContextCapability.js @@ -35,6 +35,8 @@ define( * Meant specifically for use by EditableDomainObject and the * associated cache; the constructor signature is particular * to a pattern used there and may contain unused arguments. + * @constructor + * @memberof platform/commonUI/edit */ return function EditableContextCapability( contextCapability, @@ -72,4 +74,4 @@ define( return capability; }; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/capabilities/EditableLookupCapability.js b/platform/commonUI/edit/src/capabilities/EditableLookupCapability.js index 5571072b25..727a569a15 100644 --- a/platform/commonUI/edit/src/capabilities/EditableLookupCapability.js +++ b/platform/commonUI/edit/src/capabilities/EditableLookupCapability.js @@ -35,6 +35,8 @@ define( * Meant specifically for use by EditableDomainObject and the * associated cache; the constructor signature is particular * to a pattern used there and may contain unused arguments. + * @constructor + * @memberof platform/commonUI/edit */ return function EditableLookupCapability( contextCapability, @@ -115,4 +117,4 @@ define( return capability; }; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/capabilities/EditablePersistenceCapability.js b/platform/commonUI/edit/src/capabilities/EditablePersistenceCapability.js index 5252ef1d44..5f702d71b8 100644 --- a/platform/commonUI/edit/src/capabilities/EditablePersistenceCapability.js +++ b/platform/commonUI/edit/src/capabilities/EditablePersistenceCapability.js @@ -35,6 +35,8 @@ define( * Meant specifically for use by EditableDomainObject and the * associated cache; the constructor signature is particular * to a pattern used there and may contain unused arguments. + * @constructor + * @memberof platform/commonUI/edit */ function EditablePersistenceCapability( persistenceCapability, @@ -62,4 +64,4 @@ define( return EditablePersistenceCapability; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/capabilities/EditableRelationshipCapability.js b/platform/commonUI/edit/src/capabilities/EditableRelationshipCapability.js index f61a54176c..7567143436 100644 --- a/platform/commonUI/edit/src/capabilities/EditableRelationshipCapability.js +++ b/platform/commonUI/edit/src/capabilities/EditableRelationshipCapability.js @@ -35,6 +35,8 @@ define( * Meant specifically for use by EditableDomainObject and the * associated cache; the constructor signature is particular * to a pattern used there and may contain unused arguments. + * @constructor + * @memberof platform/commonUI/edit */ return function EditableRelationshipCapability( relationshipCapability, @@ -54,4 +56,4 @@ define( ); }; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/capabilities/EditorCapability.js b/platform/commonUI/edit/src/capabilities/EditorCapability.js index e59fbcae8c..70dfa44dde 100644 --- a/platform/commonUI/edit/src/capabilities/EditorCapability.js +++ b/platform/commonUI/edit/src/capabilities/EditorCapability.js @@ -39,6 +39,8 @@ define( * Meant specifically for use by EditableDomainObject and the * associated cache; the constructor signature is particular * to a pattern used there and may contain unused arguments. + * @constructor + * @memberof platform/commonUI/edit */ return function EditorCapability( persistenceCapability, @@ -83,6 +85,7 @@ define( * object (and not other objects with associated changes) * @returns {Promise} a promise that will be fulfilled after * persistence has completed. + * @memberof platform/commonUI/edit.EditorCapability# */ save: function (nonrecursive) { return nonrecursive ? @@ -95,6 +98,7 @@ define( * been retrieved and modified during the editing session) * @returns {Promise} a promise that will be fulfilled after * cancellation has completed. + * @memberof platform/commonUI/edit.EditorCapability# */ cancel: function () { return resolvePromise(undefined); @@ -102,6 +106,7 @@ define( /** * Check if there are any unsaved changes. * @returns {boolean} true if there are unsaved changes + * @memberof platform/commonUI/edit.EditorCapability# */ dirty: function () { return cache.dirty(); @@ -109,4 +114,4 @@ define( }; }; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/controllers/EditActionController.js b/platform/commonUI/edit/src/controllers/EditActionController.js index 43c173b098..4ea38f9bb5 100644 --- a/platform/commonUI/edit/src/controllers/EditActionController.js +++ b/platform/commonUI/edit/src/controllers/EditActionController.js @@ -33,6 +33,7 @@ define( /** * Controller which supplies action instances for Save/Cancel. + * @memberof platform/commonUI/edit * @constructor */ function EditActionController($scope) { @@ -51,4 +52,4 @@ define( return EditActionController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/controllers/EditController.js b/platform/commonUI/edit/src/controllers/EditController.js index 34cabd0b0b..f0f2822207 100644 --- a/platform/commonUI/edit/src/controllers/EditController.js +++ b/platform/commonUI/edit/src/controllers/EditController.js @@ -33,6 +33,7 @@ define( * Controller which is responsible for populating the scope for * Edit mode; introduces an editable version of the currently * navigated domain object into the scope. + * @memberof platform/commonUI/edit * @constructor */ function EditController($scope, $q, navigationService) { @@ -55,6 +56,7 @@ define( /** * Get the domain object which is navigated-to. * @returns {DomainObject} the domain object that is navigated-to + * @memberof platform/commonUI/edit.EditController# */ navigatedObject: function () { return navigatedObject; @@ -64,6 +66,7 @@ define( * away from Edit mode while unsaved changes are present. * @returns {string} the warning to show, or undefined if * there are no unsaved changes + * @memberof platform/commonUI/edit.EditController# */ getUnloadWarning: function () { var editorCapability = navigatedObject && @@ -79,4 +82,4 @@ define( return EditController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/controllers/EditPanesController.js b/platform/commonUI/edit/src/controllers/EditPanesController.js index 4bfc91002c..258286216f 100644 --- a/platform/commonUI/edit/src/controllers/EditPanesController.js +++ b/platform/commonUI/edit/src/controllers/EditPanesController.js @@ -28,6 +28,7 @@ define( /** * Supports the Library and Elements panes in Edit mode. + * @memberof platform/commonUI/edit * @constructor */ function EditPanesController($scope) { @@ -56,6 +57,7 @@ define( * Get the root-level domain object, as reported by the * represented domain object. * @returns {DomainObject} the root object + * @memberof platform/commonUI/edit.EditPanesController# */ getRoot: function () { return root; @@ -65,4 +67,4 @@ define( return EditPanesController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/directives/MCTBeforeUnload.js b/platform/commonUI/edit/src/directives/MCTBeforeUnload.js index 60e825d1b0..3e7501c788 100644 --- a/platform/commonUI/edit/src/directives/MCTBeforeUnload.js +++ b/platform/commonUI/edit/src/directives/MCTBeforeUnload.js @@ -31,6 +31,7 @@ define( * to this attribute will be evaluated during page navigation events * and, if it returns a truthy value, will be used to populate a * prompt to the user to confirm this navigation. + * @memberof platform/commonUI/edit * @constructor * @param $window the window */ @@ -102,4 +103,4 @@ define( return MCTBeforeUnload; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/objects/EditableDomainObject.js b/platform/commonUI/edit/src/objects/EditableDomainObject.js index dce39bec87..47e10488ea 100644 --- a/platform/commonUI/edit/src/objects/EditableDomainObject.js +++ b/platform/commonUI/edit/src/objects/EditableDomainObject.js @@ -68,6 +68,8 @@ define( * which need to behave differently in edit mode, * and provides a "working copy" of the object's * model to allow changes to be easily cancelled. + * @constructor + * @memberof platform/commonUI/edit */ function EditableDomainObject(domainObject, $q) { // The cache will hold all domain objects reached from @@ -109,4 +111,4 @@ define( return EditableDomainObject; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js b/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js index a13a3e2360..9d69a9e364 100644 --- a/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js +++ b/platform/commonUI/edit/src/objects/EditableDomainObjectCache.js @@ -51,6 +51,7 @@ define( * an argument, and returns an editable domain object as its * result. * @param $q Angular's $q, for promise handling + * @memberof platform/commonUI/edit * @constructor * @memberof module:editor/object/editable-domain-object-cache */ @@ -66,6 +67,7 @@ define( * * @param {DomainObject} domainObject the regular domain object * @returns {DomainObject} the domain object in an editable form + * @memberof platform/commonUI/edit.EditableDomainObjectCache# */ getEditableObject: function (domainObject) { var type = domainObject.getCapability('type'); @@ -94,6 +96,7 @@ define( * Check if a domain object is (effectively) the top-level * object in this editable subgraph. * @returns {boolean} true if it is the root + * @memberof platform/commonUI/edit.EditableDomainObjectCache# */ isRoot: function (domainObject) { return domainObject === root; @@ -104,6 +107,7 @@ define( * included in the bulk save invoked when editing completes. * * @param {DomainObject} domainObject the domain object + * @memberof platform/commonUI/edit.EditableDomainObjectCache# */ markDirty: function (domainObject) { dirty[domainObject.getId()] = domainObject; @@ -114,12 +118,14 @@ define( * save operation.) * * @param {DomainObject} domainObject the domain object + * @memberof platform/commonUI/edit.EditableDomainObjectCache# */ markClean: function (domainObject) { delete dirty[domainObject.getId()]; }, /** * Initiate a save on all objects that have been cached. + * @memberof platform/commonUI/edit.EditableDomainObjectCache# */ saveAll: function () { // Get a list of all dirty objects @@ -140,6 +146,7 @@ define( /** * Check if any objects have been marked dirty in this cache. * @returns {boolean} true if objects are dirty + * @memberof platform/commonUI/edit.EditableDomainObjectCache# */ dirty: function () { return Object.keys(dirty).length > 0; @@ -150,3 +157,4 @@ define( return EditableDomainObjectCache; } ); + diff --git a/platform/commonUI/edit/src/objects/EditableModelCache.js b/platform/commonUI/edit/src/objects/EditableModelCache.js index 3652f679f7..b20ba98c8a 100644 --- a/platform/commonUI/edit/src/objects/EditableModelCache.js +++ b/platform/commonUI/edit/src/objects/EditableModelCache.js @@ -31,6 +31,7 @@ define( * made editable, to support a group that can be saved all-at-once. * This is useful in Edit mode, which is launched for a specific * object but may contain changes across many objects. + * @memberof platform/commonUI/edit * @constructor */ function EditableModelCache() { @@ -47,6 +48,7 @@ define( * Get this domain object's model from the cache (or * place it in the cache if it isn't in the cache yet) * @returns a clone of the domain object's model + * @memberof platform/commonUI/edit.EditableModelCache# */ getCachedModel: function (domainObject) { var id = domainObject.getId(); @@ -60,4 +62,4 @@ define( return EditableModelCache; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/policies/EditActionPolicy.js b/platform/commonUI/edit/src/policies/EditActionPolicy.js index 3c47af43b8..825224317a 100644 --- a/platform/commonUI/edit/src/policies/EditActionPolicy.js +++ b/platform/commonUI/edit/src/policies/EditActionPolicy.js @@ -30,6 +30,7 @@ define( * Policy controlling when the `edit` and/or `properties` actions * can appear as applicable actions of the `view-control` category * (shown as buttons in the top-right of browse mode.) + * @memberof platform/commonUI/edit * @constructor */ function EditActionPolicy() { @@ -54,6 +55,7 @@ define( * @param {Action} action the action * @param context the context * @returns {boolean} true if not disallowed + * @memberof platform/commonUI/edit.EditActionPolicy# */ allow: function (action, context) { var key = action.getMetadata().key, @@ -79,4 +81,4 @@ define( return EditActionPolicy; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/policies/EditableViewPolicy.js b/platform/commonUI/edit/src/policies/EditableViewPolicy.js index c93072e861..92fa0b5256 100644 --- a/platform/commonUI/edit/src/policies/EditableViewPolicy.js +++ b/platform/commonUI/edit/src/policies/EditableViewPolicy.js @@ -28,6 +28,7 @@ define( /** * Policy controlling which views should be visible in Edit mode. + * @memberof platform/commonUI/edit * @constructor */ function EditableViewPolicy() { @@ -38,6 +39,7 @@ define( * @param {Action} action the action * @param domainObject the domain object which will be viewed * @returns {boolean} true if not disallowed + * @memberof platform/commonUI/edit.EditableViewPolicy# */ allow: function (view, domainObject) { // If a view is flagged as non-editable, only allow it @@ -54,4 +56,4 @@ define( return EditableViewPolicy; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/representers/EditRepresenter.js b/platform/commonUI/edit/src/representers/EditRepresenter.js index 96f6da332b..2cca2ee59f 100644 --- a/platform/commonUI/edit/src/representers/EditRepresenter.js +++ b/platform/commonUI/edit/src/representers/EditRepresenter.js @@ -41,6 +41,7 @@ define( * and may be reused for different domain objects and/or * representations resulting from changes there. * + * @memberof platform/commonUI/edit * @constructor */ function EditRepresenter($q, $log, scope) { @@ -113,10 +114,12 @@ define( * definition of the representation in use * @param {DomainObject} domainObject the domain object * being represented + * @memberof platform/commonUI/edit.EditRepresenter# */ represent: represent, /** * Release any resources associated with this representer. + * @memberof platform/commonUI/edit.EditRepresenter# */ destroy: destroy }; @@ -124,4 +127,4 @@ define( return EditRepresenter; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/representers/EditToolbar.js b/platform/commonUI/edit/src/representers/EditToolbar.js index 58dab7497e..81d95582aa 100644 --- a/platform/commonUI/edit/src/representers/EditToolbar.js +++ b/platform/commonUI/edit/src/representers/EditToolbar.js @@ -38,6 +38,7 @@ define( * * @param structure toolbar structure, as provided by view definition * @param {Function} commit callback to invoke after changes + * @memberof platform/commonUI/edit * @constructor */ function EditToolbar(structure, commit) { @@ -221,6 +222,7 @@ define( * Set the current selection. Visisbility of sections * and items in the toolbar will be updated to match this. * @param {Array} s the new selection + * @memberof platform/commonUI/edit.EditToolbar# */ setSelection: function (s) { selection = s; @@ -231,6 +233,7 @@ define( * Get the structure of the toolbar, as appropriate to * pass to `mct-toolbar`. * @returns the toolbar structure + * @memberof platform/commonUI/edit.EditToolbar# */ getStructure: function () { return toolbarStructure; @@ -239,6 +242,7 @@ define( * Get the current state of the toolbar, as appropriate * to two-way bind to the state handled by `mct-toolbar`. * @returns {Array} state of the toolbar + * @memberof platform/commonUI/edit.EditToolbar# */ getState: function () { return toolbarState; @@ -248,6 +252,7 @@ define( * @param {number} index the index of the corresponding * element in the state array * @param value the new value to convey to the selection + * @memberof platform/commonUI/edit.EditToolbar# */ updateState: function (index, value) { return updateProperties(properties[index], value); @@ -259,3 +264,4 @@ define( } ); + diff --git a/platform/commonUI/edit/src/representers/EditToolbarRepresenter.js b/platform/commonUI/edit/src/representers/EditToolbarRepresenter.js index f94ddcd7a8..a574fffc77 100644 --- a/platform/commonUI/edit/src/representers/EditToolbarRepresenter.js +++ b/platform/commonUI/edit/src/representers/EditToolbarRepresenter.js @@ -33,6 +33,7 @@ define( * The EditToolbarRepresenter populates the toolbar in Edit mode * based on a view's definition. * @param {Scope} scope the Angular scope of the representation + * @memberof platform/commonUI/edit * @constructor */ function EditToolbarRepresenter(scope, element, attrs) { @@ -136,10 +137,12 @@ define( * definition of the representation in use * @param {DomainObject} domainObject the domain object * being represented + * @memberof platform/commonUI/edit.EditToolbarRepresenter# */ represent: (attrs || {}).toolbar ? represent : noop, /** * Release any resources associated with this representer. + * @memberof platform/commonUI/edit.EditToolbarRepresenter# */ destroy: (attrs || {}).toolbar ? destroy : noop }; @@ -147,4 +150,4 @@ define( return EditToolbarRepresenter; } -); \ No newline at end of file +); diff --git a/platform/commonUI/edit/src/representers/EditToolbarSelection.js b/platform/commonUI/edit/src/representers/EditToolbarSelection.js index d88ad0da1a..87483a4bbb 100644 --- a/platform/commonUI/edit/src/representers/EditToolbarSelection.js +++ b/platform/commonUI/edit/src/representers/EditToolbarSelection.js @@ -37,6 +37,7 @@ define( * * The selection, for single selected elements within the * view. * + * @memberof platform/commonUI/edit * @constructor */ function EditToolbarSelection() { @@ -106,22 +107,26 @@ define( /** * Check if an object is currently selected. * @returns true if selected, otherwise false + * @memberof platform/commonUI/edit.EditToolbarSelection# */ selected: isSelected, /** * Select an object. * @param obj the object to select * @returns {boolean} true if selection changed + * @memberof platform/commonUI/edit.EditToolbarSelection# */ select: select, /** * Clear the current selection. * @returns {boolean} true if selection changed + * @memberof platform/commonUI/edit.EditToolbarSelection# */ deselect: deselect, /** * Get the currently-selected object. * @returns the currently selected object + * @memberof platform/commonUI/edit.EditToolbarSelection# */ get: get, /** @@ -129,6 +134,7 @@ define( * the view itself.) * @param [proxy] the view proxy (if setting) * @returns the current view proxy + * @memberof platform/commonUI/edit.EditToolbarSelection# */ proxy: proxy, /** @@ -136,6 +142,7 @@ define( * selection proxy. It is generally not advisable to * mutate this array directly. * @returns {Array} all selections + * @memberof platform/commonUI/edit.EditToolbarSelection# */ all: all }; @@ -143,4 +150,4 @@ define( return EditToolbarSelection; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/StyleSheetLoader.js b/platform/commonUI/general/src/StyleSheetLoader.js index 9775288b28..fe535df888 100644 --- a/platform/commonUI/general/src/StyleSheetLoader.js +++ b/platform/commonUI/general/src/StyleSheetLoader.js @@ -29,6 +29,7 @@ define( /** * The StyleSheetLoader adds links to style sheets exposed from * various bundles as extensions of category `stylesheets`. + * @memberof platform/commonUI/general * @constructor * @param {object[]} stylesheets stylesheet extension definitions * @param $document Angular's jqLite-wrapped document element @@ -62,4 +63,4 @@ define( return StyleSheetLoader; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/ActionGroupController.js b/platform/commonUI/general/src/controllers/ActionGroupController.js index 1675d2e611..0992b5e967 100644 --- a/platform/commonUI/general/src/controllers/ActionGroupController.js +++ b/platform/commonUI/general/src/controllers/ActionGroupController.js @@ -42,6 +42,7 @@ define( * * `ungrouped`: All actions which did not have a defined * group. * + * @memberof platform/commonUI/general * @constructor */ function ActionGroupController($scope) { @@ -102,4 +103,4 @@ define( return ActionGroupController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/BottomBarController.js b/platform/commonUI/general/src/controllers/BottomBarController.js index b33ce0fe7a..18e3e04dfc 100644 --- a/platform/commonUI/general/src/controllers/BottomBarController.js +++ b/platform/commonUI/general/src/controllers/BottomBarController.js @@ -29,6 +29,7 @@ define( /** * Controller for the bottombar template. Exposes * available indicators (of extension category "indicators") + * @memberof platform/commonUI/general * @constructor */ function BottomBarController(indicators) { @@ -49,6 +50,7 @@ define( * Get all indicators to display. * @returns {Indicator[]} all indicators * to display in the bottom bar. + * @memberof platform/commonUI/general.BottomBarController# */ getIndicators: function () { return indicators; @@ -58,4 +60,4 @@ define( return BottomBarController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/ClickAwayController.js b/platform/commonUI/general/src/controllers/ClickAwayController.js index 75b1d985da..390e24f50a 100644 --- a/platform/commonUI/general/src/controllers/ClickAwayController.js +++ b/platform/commonUI/general/src/controllers/ClickAwayController.js @@ -31,6 +31,7 @@ define( * menus) where clicking elsewhere in the document while the toggle * is in an active state is intended to dismiss the toggle. * + * @memberof platform/commonUI/general * @constructor * @param $scope the scope in which this controller is active * @param $document the document element, injected by Angular @@ -72,6 +73,7 @@ define( /** * Get the current state of the toggle. * @return {boolean} true if active + * @memberof platform/commonUI/general.ClickAwayController# */ isActive: function () { return state; @@ -79,6 +81,7 @@ define( /** * Set a new state for the toggle. * @return {boolean} true to activate + * @memberof platform/commonUI/general.ClickAwayController# */ setState: function (newState) { if (state !== newState) { @@ -88,6 +91,7 @@ define( /** * Toggle the current state; activate if it is inactive, * deactivate if it is active. + * @memberof platform/commonUI/general.ClickAwayController# */ toggle: function () { changeState(); @@ -98,4 +102,4 @@ define( return ClickAwayController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/ContextMenuController.js b/platform/commonUI/general/src/controllers/ContextMenuController.js index 4e1bcd3b8f..dece522682 100644 --- a/platform/commonUI/general/src/controllers/ContextMenuController.js +++ b/platform/commonUI/general/src/controllers/ContextMenuController.js @@ -33,6 +33,7 @@ define( * Controller for the context menu. Maintains an up-to-date * list of applicable actions (those from category "contextual") * + * @memberof platform/commonUI/general * @constructor */ function ContextMenuController($scope) { @@ -49,4 +50,4 @@ define( return ContextMenuController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/GetterSetterController.js b/platform/commonUI/general/src/controllers/GetterSetterController.js index 05d7b2f4ef..3d61c00116 100644 --- a/platform/commonUI/general/src/controllers/GetterSetterController.js +++ b/platform/commonUI/general/src/controllers/GetterSetterController.js @@ -54,6 +54,7 @@ define( * parameter it received.) Getter-setter functions are never the * target of a scope assignment and so avoid this problem. * + * @memberof platform/commonUI/general * @constructor * @param {Scope} $scope the controller's scope */ @@ -87,4 +88,4 @@ define( return GetterSetterController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/SelectorController.js b/platform/commonUI/general/src/controllers/SelectorController.js index 5b09f3423a..87f9b22b84 100644 --- a/platform/commonUI/general/src/controllers/SelectorController.js +++ b/platform/commonUI/general/src/controllers/SelectorController.js @@ -30,6 +30,7 @@ define( /** * Controller for the domain object selector control. + * @memberof platform/commonUI/general * @constructor * @param {ObjectService} objectService service from which to * read domain objects @@ -102,6 +103,7 @@ define( /** * Get the root object to show in the left-hand tree. * @returns {DomainObject} the root object + * @memberof platform/commonUI/general.SelectorController# */ root: function () { return rootObject; @@ -109,6 +111,7 @@ define( /** * Add a domain object to the list of selected objects. * @param {DomainObject} the domain object to select + * @memberof platform/commonUI/general.SelectorController# */ select: function (domainObject) { var id = domainObject && domainObject.getId(), @@ -122,6 +125,7 @@ define( /** * Remove a domain object from the list of selected objects. * @param {DomainObject} the domain object to select + * @memberof platform/commonUI/general.SelectorController# */ deselect: function (domainObject) { var id = domainObject && domainObject.getId(), @@ -140,6 +144,7 @@ define( /** * Get the currently-selected domain objects. * @returns {DomainObject[]} the current selection + * @memberof platform/commonUI/general.SelectorController# */ selected: function () { return selectedObjects; @@ -153,4 +158,4 @@ define( return SelectorController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/SplitPaneController.js b/platform/commonUI/general/src/controllers/SplitPaneController.js index c747f2f256..9eb9daa4c6 100644 --- a/platform/commonUI/general/src/controllers/SplitPaneController.js +++ b/platform/commonUI/general/src/controllers/SplitPaneController.js @@ -32,6 +32,7 @@ define( /** * Controller for the splitter in Browse mode. Current implementation * uses many hard-coded constants; this could be generalized. + * @memberof platform/commonUI/general * @constructor */ function SplitPaneController() { @@ -44,6 +45,7 @@ define( * Get the current position of the splitter, in pixels * from the left edge. * @returns {number} position of the splitter, in pixels + * @memberof platform/commonUI/general.SplitPaneController# */ state: function (defaultState) { // Set the state to the desired default, if we don't have a @@ -58,6 +60,7 @@ define( * Begin moving the splitter; this will note the splitter's * current position, which is necessary for correct * interpretation of deltas provided by mct-drag. + * @memberof platform/commonUI/general.SplitPaneController# */ startMove: function () { start = current; @@ -68,6 +71,7 @@ define( * This movement is relative to the position of the * splitter when startMove was last invoked. * @param {number} delta number of pixels to move + * @memberof platform/commonUI/general.SplitPaneController# */ move: function (delta, minimum, maximum) { // Ensure defaults for minimum/maximum @@ -87,4 +91,4 @@ define( return SplitPaneController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/ToggleController.js b/platform/commonUI/general/src/controllers/ToggleController.js index 0d3bd664ca..d6e73414a1 100644 --- a/platform/commonUI/general/src/controllers/ToggleController.js +++ b/platform/commonUI/general/src/controllers/ToggleController.js @@ -30,6 +30,7 @@ define( * A ToggleController is used to activate/deactivate things. * A common usage is for "twistie" * + * @memberof platform/commonUI/general * @constructor */ function ToggleController() { @@ -39,6 +40,7 @@ define( /** * Get the current state of the toggle. * @return {boolean} true if active + * @memberof platform/commonUI/general.ToggleController# */ isActive: function () { return state; @@ -46,6 +48,7 @@ define( /** * Set a new state for the toggle. * @return {boolean} true to activate + * @memberof platform/commonUI/general.ToggleController# */ setState: function (newState) { state = newState; @@ -53,6 +56,7 @@ define( /** * Toggle the current state; activate if it is inactive, * deactivate if it is active. + * @memberof platform/commonUI/general.ToggleController# */ toggle: function () { state = !state; @@ -63,4 +67,4 @@ define( return ToggleController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/TreeNodeController.js b/platform/commonUI/general/src/controllers/TreeNodeController.js index 77124bb6e3..3310bf2ae0 100644 --- a/platform/commonUI/general/src/controllers/TreeNodeController.js +++ b/platform/commonUI/general/src/controllers/TreeNodeController.js @@ -48,6 +48,7 @@ define( * node expansion when this tree node's _subtree_ will contain * the navigated object (recursively, this becomes an * expand-to-show-navigated-object behavior.) + * @memberof platform/commonUI/general * @constructor */ function TreeNodeController($scope, $timeout, $rootScope) { @@ -148,11 +149,13 @@ define( * This method should be called when a node is expanded * to record that this has occurred, to support one-time * lazy loading of the node's subtree. + * @memberof platform/commonUI/general.TreeNodeController# */ trackExpansion: trackExpansion, /** * Check if this not has ever been expanded. * @returns true if it has been expanded + * @memberof platform/commonUI/general.TreeNodeController# */ hasBeenExpanded: function () { return hasBeenExpanded; @@ -163,6 +166,7 @@ define( * An object will be highlighted if it matches * ngModel.selectedObject * @returns true if this should be highlighted + * @memberof platform/commonUI/general.TreeNodeController# */ isSelected: function () { return isSelected; @@ -172,4 +176,4 @@ define( return TreeNodeController; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/controllers/ViewSwitcherController.js b/platform/commonUI/general/src/controllers/ViewSwitcherController.js index 69674013d5..a3ab2e7bc4 100644 --- a/platform/commonUI/general/src/controllers/ViewSwitcherController.js +++ b/platform/commonUI/general/src/controllers/ViewSwitcherController.js @@ -32,6 +32,7 @@ define( /** * Controller for the view switcher; populates and maintains a list * of applicable views for a represented domain object. + * @memberof platform/commonUI/general * @constructor */ function ViewSwitcherController($scope, $timeout) { @@ -71,3 +72,4 @@ define( return ViewSwitcherController; } ); + diff --git a/platform/commonUI/general/src/directives/MCTContainer.js b/platform/commonUI/general/src/directives/MCTContainer.js index 00b7b2b21a..f65cf0803d 100644 --- a/platform/commonUI/general/src/directives/MCTContainer.js +++ b/platform/commonUI/general/src/directives/MCTContainer.js @@ -39,6 +39,7 @@ define( * plain string attribute, instead of as an Angular * expression. * + * @memberof platform/commonUI/general * @constructor */ function MCTContainer(containers) { @@ -96,4 +97,4 @@ define( return MCTContainer; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/directives/MCTDrag.js b/platform/commonUI/general/src/directives/MCTDrag.js index f12aae5c5f..7bccccdf28 100644 --- a/platform/commonUI/general/src/directives/MCTDrag.js +++ b/platform/commonUI/general/src/directives/MCTDrag.js @@ -44,6 +44,7 @@ define( * and vertical pixel offset of the current mouse position * relative to the mouse position where dragging began. * + * @memberof platform/commonUI/general * @constructor * */ @@ -157,3 +158,4 @@ define( return MCTDrag; } ); + diff --git a/platform/commonUI/general/src/directives/MCTResize.js b/platform/commonUI/general/src/directives/MCTResize.js index 62ae977271..c78039627a 100644 --- a/platform/commonUI/general/src/directives/MCTResize.js +++ b/platform/commonUI/general/src/directives/MCTResize.js @@ -49,6 +49,7 @@ define( * This is an Angular expression, and it will be re-evaluated after * each interval. * + * @memberof platform/commonUI/general * @constructor * */ @@ -111,4 +112,4 @@ define( return MCTResize; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/directives/MCTScroll.js b/platform/commonUI/general/src/directives/MCTScroll.js index 3df79f23b2..6b9d480c66 100644 --- a/platform/commonUI/general/src/directives/MCTScroll.js +++ b/platform/commonUI/general/src/directives/MCTScroll.js @@ -37,6 +37,7 @@ define( * This is exposed as two directives in `bundle.json`; the difference * is handled purely by parameterization. * + * @memberof platform/commonUI/general * @constructor * @param $parse Angular's $parse * @param {string} property property to manage within the HTML element @@ -80,4 +81,4 @@ define( return MCTScroll; } -); \ No newline at end of file +); diff --git a/platform/commonUI/general/src/directives/MCTSplitPane.js b/platform/commonUI/general/src/directives/MCTSplitPane.js index 8d95ff2b69..688689d79f 100644 --- a/platform/commonUI/general/src/directives/MCTSplitPane.js +++ b/platform/commonUI/general/src/directives/MCTSplitPane.js @@ -91,6 +91,7 @@ define( * etc. can be set on that element to control the splitter's * allowable positions. * + * @memberof platform/commonUI/general * @constructor */ function MCTSplitPane($parse, $log) { @@ -213,3 +214,4 @@ define( } ); + diff --git a/platform/commonUI/general/src/directives/MCTSplitter.js b/platform/commonUI/general/src/directives/MCTSplitter.js index 0494830057..5216c69358 100644 --- a/platform/commonUI/general/src/directives/MCTSplitter.js +++ b/platform/commonUI/general/src/directives/MCTSplitter.js @@ -39,6 +39,7 @@ define( /** * Implements `mct-splitter` directive. + * @memberof platform/commonUI/general * @constructor */ function MCTSplitter() { @@ -88,3 +89,4 @@ define( } ); + diff --git a/platform/commonUI/general/src/services/UrlService.js b/platform/commonUI/general/src/services/UrlService.js index 4562059d0c..79931add04 100644 --- a/platform/commonUI/general/src/services/UrlService.js +++ b/platform/commonUI/general/src/services/UrlService.js @@ -32,6 +32,8 @@ define( /** * The url service handles calls for url paths * using domain objects. + * @constructor + * @memberof platform/commonUI/general */ function UrlService($location) { // Returns the url for the mode wanted @@ -73,6 +75,7 @@ define( * for the path * @param {DomainObject} value of the domain object * to get the path of + * @memberof platform/commonUI/general.UrlService# */ urlForNewTab: urlForNewTab, /** @@ -83,6 +86,7 @@ define( * for the path * @param {DomainObject} value of the domain object * to get the path of + * @memberof platform/commonUI/general.UrlService# */ urlForLocation: urlForLocation }; @@ -90,4 +94,4 @@ define( return UrlService; } -); \ No newline at end of file +); diff --git a/platform/commonUI/inspect/src/InfoConstants.js b/platform/commonUI/inspect/src/InfoConstants.js index 5e43a1b618..c5886cba92 100644 --- a/platform/commonUI/inspect/src/InfoConstants.js +++ b/platform/commonUI/inspect/src/InfoConstants.js @@ -33,4 +33,4 @@ define({ // Max width and margins allowed for bubbles; defined in /platform/commonUI/general/res/sass/_constants.scss BUBBLE_MARGIN_LR: 10, BUBBLE_MAX_WIDTH: 300 -}); \ No newline at end of file +}); diff --git a/platform/commonUI/inspect/src/gestures/InfoGesture.js b/platform/commonUI/inspect/src/gestures/InfoGesture.js index 879cc2ac36..a22c4515fa 100644 --- a/platform/commonUI/inspect/src/gestures/InfoGesture.js +++ b/platform/commonUI/inspect/src/gestures/InfoGesture.js @@ -30,6 +30,7 @@ define( * The `info` gesture displays domain object metadata in a * bubble on hover. * + * @memberof platform/commonUI/inspect * @constructor * @param $timeout Angular's `$timeout` * @param {InfoService} infoService a service which shows info bubbles @@ -103,6 +104,7 @@ define( * Detach any event handlers associated with this gesture. * @memberof InfoGesture * @method + * @memberof platform/commonUI/inspect.InfoGesture# */ destroy: function () { // Dismiss any active bubble... @@ -119,3 +121,4 @@ define( } ); + diff --git a/platform/commonUI/inspect/src/services/InfoService.js b/platform/commonUI/inspect/src/services/InfoService.js index b67192ba30..ed5bbfaa48 100644 --- a/platform/commonUI/inspect/src/services/InfoService.js +++ b/platform/commonUI/inspect/src/services/InfoService.js @@ -31,6 +31,7 @@ define( /** * Displays informative content ("info bubbles") for the user. + * @memberof platform/commonUI/inspect * @constructor */ function InfoService($compile, $document, $window, $rootScope) { @@ -85,6 +86,7 @@ define( * pixel coordinates. * @returns {Function} a function that may be invoked to * dismiss the info bubble + * @memberof platform/commonUI/inspect.InfoService# */ display: display }; @@ -93,3 +95,4 @@ define( return InfoService; } ); + diff --git a/platform/containment/src/CapabilityTable.js b/platform/containment/src/CapabilityTable.js index db14c0f20f..5a2374af5d 100644 --- a/platform/containment/src/CapabilityTable.js +++ b/platform/containment/src/CapabilityTable.js @@ -32,6 +32,8 @@ define( * which capabilities. This supports composition policy (rules * for which objects can contain which other objects) which * sometimes is determined based on the presence of capabilities. + * @constructor + * @memberof platform/containment */ function CapabilityTable(typeService, capabilityService) { var table = {}; @@ -64,6 +66,7 @@ define( /** * Check if a type is expected to expose a specific * capability. + * @memberof platform/containment.CapabilityTable# */ hasCapability: function (typeKey, capabilityKey) { return (table[capabilityKey] || {})[typeKey]; @@ -73,4 +76,4 @@ define( return CapabilityTable; } -); \ No newline at end of file +); diff --git a/platform/containment/src/ComposeActionPolicy.js b/platform/containment/src/ComposeActionPolicy.js index 6d3952b763..90c7983bc9 100644 --- a/platform/containment/src/ComposeActionPolicy.js +++ b/platform/containment/src/ComposeActionPolicy.js @@ -34,6 +34,8 @@ define( * since it's delegated to a different policy category. * To avoid a circular dependency, the service is obtained via * Angular's `$injector`. + * @constructor + * @memberof platform/containment */ function ComposeActionPolicy($injector) { var policyService; @@ -61,6 +63,7 @@ define( * Check whether or not a compose action should be allowed * in this context. * @returns {boolean} true if it may be allowed + * @memberof platform/containment.ComposeActionPolicy# */ allow: function (candidate, context) { if (candidate.getMetadata().key === 'compose') { @@ -77,4 +80,4 @@ define( return ComposeActionPolicy; } -); \ No newline at end of file +); diff --git a/platform/containment/src/CompositionModelPolicy.js b/platform/containment/src/CompositionModelPolicy.js index 74f1200530..0c76097ed4 100644 --- a/platform/containment/src/CompositionModelPolicy.js +++ b/platform/containment/src/CompositionModelPolicy.js @@ -8,12 +8,15 @@ define( /** * Policy allowing composition only for domain object types which * have a composition property. + * @constructor + * @memberof platform/containment */ function CompositionModelPolicy() { return { /** * Is the type identified by the candidate allowed to * contain the type described by the context? + * @memberof platform/containment.CompositionModelPolicy# */ allow: function (candidate, context) { return Array.isArray( @@ -25,4 +28,4 @@ define( return CompositionModelPolicy; } -); \ No newline at end of file +); diff --git a/platform/containment/src/CompositionMutabilityPolicy.js b/platform/containment/src/CompositionMutabilityPolicy.js index 9b3e12eb95..375f26e405 100644 --- a/platform/containment/src/CompositionMutabilityPolicy.js +++ b/platform/containment/src/CompositionMutabilityPolicy.js @@ -28,6 +28,7 @@ define( /** * Disallow composition changes to objects which are not mutable. + * @memberof platform/containment * @constructor */ function CompositionMutabilityPolicy() { @@ -36,6 +37,7 @@ define( * Is the type identified by the candidate allowed to * contain the type described by the context? * @param {Type} candidate the type of domain object + * @memberof platform/containment.CompositionMutabilityPolicy# */ allow: function (candidate) { // Equate creatability with mutability; that is, users @@ -48,4 +50,4 @@ define( return CompositionMutabilityPolicy; } -); \ No newline at end of file +); diff --git a/platform/containment/src/CompositionPolicy.js b/platform/containment/src/CompositionPolicy.js index 992fced49f..2fcd4e94a9 100644 --- a/platform/containment/src/CompositionPolicy.js +++ b/platform/containment/src/CompositionPolicy.js @@ -28,6 +28,8 @@ define( /** * Defines composition policy as driven by type metadata. + * @constructor + * @memberof platform/containment */ function CompositionPolicy($injector) { // We're really just wrapping the containment table and rephrasing @@ -45,6 +47,7 @@ define( /** * Is the type identified by the candidate allowed to * contain the type described by the context? + * @memberof platform/containment.CompositionPolicy# */ allow: function (candidate, context) { return getTable().canContain(candidate, context); @@ -54,4 +57,4 @@ define( return CompositionPolicy; } -); \ No newline at end of file +); diff --git a/platform/containment/src/ContainmentTable.js b/platform/containment/src/ContainmentTable.js index a3d7ab6ed4..a71570ca3a 100644 --- a/platform/containment/src/ContainmentTable.js +++ b/platform/containment/src/ContainmentTable.js @@ -37,6 +37,8 @@ define( * start time (plug-in support means this cannot be determined * prior to that, but we don't want to redo these calculations * every time policy is checked.) + * @constructor + * @memberof platform/containment */ function ContainmentTable(typeService, capabilityService) { var types = typeService.listTypes(), @@ -103,6 +105,7 @@ define( * Check if domain objects of one type can contain domain * objects of another type. * @returns {boolean} true if allowable + * @memberof platform/containment.ContainmentTable# */ canContain: function (containerType, containedType) { var set = table[containerType.getKey()] || {}; @@ -116,4 +119,4 @@ define( return ContainmentTable; } -); \ No newline at end of file +); diff --git a/platform/core/src/actions/ActionAggregator.js b/platform/core/src/actions/ActionAggregator.js index 4a9288a612..c12f3cf07d 100644 --- a/platform/core/src/actions/ActionAggregator.js +++ b/platform/core/src/actions/ActionAggregator.js @@ -31,6 +31,7 @@ define( * actions for a given context, results from all * services will be assembled and concatenated. * + * @memberof platform/core * @constructor * @param {ActionProvider[]} actionProviders an array * of action services @@ -65,6 +66,7 @@ define( * * @method * @memberof ActionAggregator + * @memberof platform/core.ActionAggregator# */ getActions: getActions }; @@ -72,4 +74,4 @@ define( return ActionAggregator; } -); \ No newline at end of file +); diff --git a/platform/core/src/actions/ActionCapability.js b/platform/core/src/actions/ActionCapability.js index 94b0706a0d..b5d055bcb0 100644 --- a/platform/core/src/actions/ActionCapability.js +++ b/platform/core/src/actions/ActionCapability.js @@ -45,6 +45,7 @@ define( * which the action will be performed (also, the * action which exposes the capability.) * + * @memberof platform/core * @constructor */ function ActionCapability($q, actionService, domainObject) { @@ -92,6 +93,7 @@ define( * @returns {Promise} the result of the action that was * performed, or undefined if no matching action * was found. + * @memberof platform/core.ActionCapability# */ perform: performAction, /** @@ -107,6 +109,7 @@ define( * be taken as the "key" field to match against * specific actions. * @returns {Action[]} an array of matching actions + * @memberof platform/core.ActionCapability# */ getActions: getActions }; @@ -114,4 +117,4 @@ define( return ActionCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/actions/ActionProvider.js b/platform/core/src/actions/ActionProvider.js index 5937f00fc2..67bc56520f 100644 --- a/platform/core/src/actions/ActionProvider.js +++ b/platform/core/src/actions/ActionProvider.js @@ -35,6 +35,7 @@ define( * of actions exposed via extension (specifically, the "actions" * category of extension.) * + * @memberof platform/core * @constructor */ function ActionProvider(actions) { @@ -145,6 +146,7 @@ define( * * @method * @memberof ActionProvider + * @memberof platform/core.ActionProvider# */ getActions: getActions }; @@ -152,4 +154,4 @@ define( return ActionProvider; } -); \ No newline at end of file +); diff --git a/platform/core/src/actions/LoggingActionDecorator.js b/platform/core/src/actions/LoggingActionDecorator.js index 3e9652d229..cb6efa245e 100644 --- a/platform/core/src/actions/LoggingActionDecorator.js +++ b/platform/core/src/actions/LoggingActionDecorator.js @@ -34,6 +34,7 @@ define( * the actions it exposes always emit a log message when they are * performed. * + * @memberof platform/core * @constructor */ function LoggingActionDecorator($log, actionService) { @@ -77,6 +78,7 @@ define( * * @method * @memberof LoggingActionDecorator + * @memberof platform/core.LoggingActionDecorator# */ getActions: function () { return actionService.getActions.apply( @@ -89,4 +91,4 @@ define( return LoggingActionDecorator; } -); \ No newline at end of file +); diff --git a/platform/core/src/capabilities/CompositionCapability.js b/platform/core/src/capabilities/CompositionCapability.js index 8049d5b3c4..88ed279dd7 100644 --- a/platform/core/src/capabilities/CompositionCapability.js +++ b/platform/core/src/capabilities/CompositionCapability.js @@ -37,6 +37,7 @@ define( * require consulting the object service (e.g. to trigger a database * query to retrieve the nested object models.) * + * @memberof platform/core * @constructor */ function CompositionCapability($injector, domainObject) { @@ -94,6 +95,7 @@ define( * Request the composition of this object. * @returns {Promise.} a list of all domain * objects which compose this domain object. + * @memberof platform/core.CompositionCapability# */ invoke: promiseComposition }; @@ -112,4 +114,4 @@ define( return CompositionCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/capabilities/ContextCapability.js b/platform/core/src/capabilities/ContextCapability.js index 9eeb00823b..d94c7ed3f6 100644 --- a/platform/core/src/capabilities/ContextCapability.js +++ b/platform/core/src/capabilities/ContextCapability.js @@ -36,6 +36,7 @@ define( * those whose `composition` capability was used to access this * object.) * + * @memberof platform/core * @constructor */ function ContextCapability(parentObject, domainObject) { @@ -50,6 +51,7 @@ define( * * @returns {DomainObject} the immediate parent of this * domain object. + * @memberof platform/core.ContextCapability# */ getParent: function () { return parentObject; @@ -72,6 +74,7 @@ define( * @returns {DomainObject[]} the full composition ancestry * of the domain object which exposed this * capability. + * @memberof platform/core.ContextCapability# */ getPath: function () { var parentPath = [], @@ -95,6 +98,7 @@ define( * * @returns {DomainObject} the deepest ancestor of the domain * object which exposed this capability. + * @memberof platform/core.ContextCapability# */ getRoot: function () { var parentContext = parentObject && @@ -109,4 +113,4 @@ define( return ContextCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/capabilities/ContextualDomainObject.js b/platform/core/src/capabilities/ContextualDomainObject.js index 0d042923a0..1475d3d384 100644 --- a/platform/core/src/capabilities/ContextualDomainObject.js +++ b/platform/core/src/capabilities/ContextualDomainObject.js @@ -42,6 +42,7 @@ define( * @param {DomainObject} parentObject the domain object from which * the wrapped object was retrieved * + * @memberof platform/core * @constructor */ function ContextualDomainObject(domainObject, parentObject) { @@ -63,4 +64,4 @@ define( return ContextualDomainObject; } -); \ No newline at end of file +); diff --git a/platform/core/src/capabilities/CoreCapabilityProvider.js b/platform/core/src/capabilities/CoreCapabilityProvider.js index 89660b72ee..a1148430f2 100644 --- a/platform/core/src/capabilities/CoreCapabilityProvider.js +++ b/platform/core/src/capabilities/CoreCapabilityProvider.js @@ -37,6 +37,7 @@ define( * of constructor functions for capabilities, as * exposed by extensions defined at the bundle level. * + * @memberof platform/core * @constructor */ function CoreCapabilityProvider(capabilities, $log) { @@ -84,6 +85,7 @@ define( * @returns {Object.} all * capabilities known to be valid for this model, as * key-value pairs + * @memberof platform/core.CoreCapabilityProvider# */ getCapabilities: getCapabilities }; @@ -92,3 +94,4 @@ define( return CoreCapabilityProvider; } ); + diff --git a/platform/core/src/capabilities/DelegationCapability.js b/platform/core/src/capabilities/DelegationCapability.js index 452b842452..2259e5c420 100644 --- a/platform/core/src/capabilities/DelegationCapability.js +++ b/platform/core/src/capabilities/DelegationCapability.js @@ -46,6 +46,7 @@ define( * capabilities to be delegated. * * @param domainObject + * @memberof platform/core * @constructor */ function DelegationCapability($q, domainObject) { @@ -96,6 +97,7 @@ define( * @param {string} the name of the delegated capability * @returns {DomainObject[]} the domain objects to which * responsibility for this capability is delegated. + * @memberof platform/core.DelegationCapability# */ invoke: getDelegates, /** @@ -105,6 +107,7 @@ define( * @param {string} the name of the delegated capability * @returns {DomainObject[]} the domain objects to which * responsibility for this capability is delegated. + * @memberof platform/core.DelegationCapability# */ getDelegates: getDelegates, doesDelegateCapability: doesDelegate @@ -115,4 +118,4 @@ define( return DelegationCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/capabilities/MetadataCapability.js b/platform/core/src/capabilities/MetadataCapability.js index 677dab0008..027c9ffe1d 100644 --- a/platform/core/src/capabilities/MetadataCapability.js +++ b/platform/core/src/capabilities/MetadataCapability.js @@ -11,6 +11,8 @@ define( * @property {string} name the human-readable name of this property * @property {string} value the human-readable value of this property, * for this specific domain object + * @constructor + * @memberof platform/core */ var TIME_FORMAT = "YYYY-MM-DD HH:mm:ss"; @@ -82,6 +84,7 @@ define( /** * Get metadata about this object. * @returns {MetadataProperty[]} metadata about this object + * @memberof platform/core.MetadataCapability# */ invoke: getMetadata }; @@ -90,3 +93,4 @@ define( return MetadataCapability; } ); + diff --git a/platform/core/src/capabilities/MutationCapability.js b/platform/core/src/capabilities/MutationCapability.js index 4268f7c323..8ba11be13b 100644 --- a/platform/core/src/capabilities/MutationCapability.js +++ b/platform/core/src/capabilities/MutationCapability.js @@ -71,6 +71,7 @@ define( * * @param {DomainObject} domainObject the domain object * which will expose this capability + * @memberof platform/core * @constructor */ function MutationCapability(topic, now, domainObject) { @@ -118,6 +119,7 @@ define( return { /** * Alias of `mutate`, used to support useCapability. + * @memberof platform/core.MutationCapability# */ invoke: mutate, /** @@ -146,6 +148,7 @@ define( * used) * @returns {Promise.} a promise for the result * of the mutation; true if changes were made. + * @memberof platform/core.MutationCapability# */ mutate: mutate, /** @@ -155,6 +158,7 @@ define( * invoke the function returned by this method. * @param {Function} listener function to call on mutation * @returns {Function} a function to stop listening + * @memberof platform/core.MutationCapability# */ listen: listen }; @@ -163,3 +167,4 @@ define( return MutationCapability; } ); + diff --git a/platform/core/src/capabilities/PersistenceCapability.js b/platform/core/src/capabilities/PersistenceCapability.js index 68c3255412..de18b69222 100644 --- a/platform/core/src/capabilities/PersistenceCapability.js +++ b/platform/core/src/capabilities/PersistenceCapability.js @@ -40,6 +40,7 @@ define( * @param {DomainObject} the domain object which shall expose * this capability * + * @memberof platform/core * @constructor */ function PersistenceCapability(persistenceService, SPACE, domainObject) { @@ -80,6 +81,7 @@ define( * @returns {Promise} a promise which will be resolved * if persistence is successful, and rejected * if not. + * @memberof platform/core.PersistenceCapability# */ persist: function () { updatePersistenceTimestamp(); @@ -94,6 +96,7 @@ define( * persistence. * @returns {Promise} a promise which will be resolved * when the update is complete + * @memberof platform/core.PersistenceCapability# */ refresh: function () { var model = domainObject.getModel(); @@ -114,6 +117,7 @@ define( * * @returns {string} the name of the space which should * be used to persist this object + * @memberof platform/core.PersistenceCapability# */ getSpace: function () { return SPACE; @@ -123,4 +127,4 @@ define( return PersistenceCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/capabilities/RelationshipCapability.js b/platform/core/src/capabilities/RelationshipCapability.js index fc8729a9a1..3bbc210b36 100644 --- a/platform/core/src/capabilities/RelationshipCapability.js +++ b/platform/core/src/capabilities/RelationshipCapability.js @@ -38,6 +38,7 @@ define( * which are not intended to appear in the tree, but are instead * intended only for special, limited usage. * + * @memberof platform/core * @constructor */ function RelationshipCapability($injector, domainObject) { @@ -109,6 +110,7 @@ define( * List all types of relationships exposed by this * object. * @returns {string[]} a list of all relationship types + * @memberof platform/core.RelationshipCapability# */ listRelationships: listRelationships, /** @@ -118,6 +120,7 @@ define( * @param {string} key the type of relationship * @returns {Promise.} a promise for related * domain objects + * @memberof platform/core.RelationshipCapability# */ getRelatedObjects: promiseRelationships }; @@ -136,4 +139,4 @@ define( return RelationshipCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/models/CachingModelDecorator.js b/platform/core/src/models/CachingModelDecorator.js index d9d4ef6775..c74cea05f0 100644 --- a/platform/core/src/models/CachingModelDecorator.js +++ b/platform/core/src/models/CachingModelDecorator.js @@ -30,6 +30,7 @@ define( * The caching model decorator maintains a cache of loaded domain * object models, and ensures that duplicate models for the same * object are not provided. + * @memberof platform/core * @constructor */ function CachingModelDecorator(modelService) { @@ -114,6 +115,7 @@ define( * containing key-value pairs, where keys are * ids and values are models * @method + * @memberof platform/core.CachingModelDecorator# */ getModels: function (ids) { var neededIds = ids.filter(notCached); @@ -133,4 +135,4 @@ define( return CachingModelDecorator; } -); \ No newline at end of file +); diff --git a/platform/core/src/models/MissingModelDecorator.js b/platform/core/src/models/MissingModelDecorator.js index 3c82bd2726..fca716733e 100644 --- a/platform/core/src/models/MissingModelDecorator.js +++ b/platform/core/src/models/MissingModelDecorator.js @@ -30,6 +30,8 @@ define( * Adds placeholder domain object models for any models which * fail to load from the underlying model service. * @implements {ModelService} + * @constructor + * @memberof platform/core */ function MissingModelDecorator(modelService) { function missingModel(id) { @@ -57,3 +59,4 @@ define( return MissingModelDecorator; } ); + diff --git a/platform/core/src/models/ModelAggregator.js b/platform/core/src/models/ModelAggregator.js index 30b645ff86..437bba4ec3 100644 --- a/platform/core/src/models/ModelAggregator.js +++ b/platform/core/src/models/ModelAggregator.js @@ -33,6 +33,7 @@ define( * Allows multiple services which provide models for domain objects * to be treated as one. * + * @memberof platform/core * @constructor * @param {ModelProvider[]} providers the model providers to be * aggregated @@ -77,6 +78,7 @@ define( * containing key-value pairs, * where keys are object identifiers and values * are object models. + * @memberof platform/core.ModelAggregator# */ getModels: function (ids) { return $q.all(providers.map(function (provider) { @@ -90,4 +92,4 @@ define( return ModelAggregator; } -); \ No newline at end of file +); diff --git a/platform/core/src/models/PersistedModelProvider.js b/platform/core/src/models/PersistedModelProvider.js index add01ba654..311f40eeaa 100644 --- a/platform/core/src/models/PersistedModelProvider.js +++ b/platform/core/src/models/PersistedModelProvider.js @@ -33,6 +33,7 @@ define( * A model service which reads domain object models from an external * persistence service. * + * @memberof platform/core * @constructor * @param {PersistenceService} persistenceService the service in which * domain object models are persisted. @@ -83,6 +84,7 @@ define( * containing key-value pairs, * where keys are object identifiers and values * are object models. + * @memberof platform/core.PersistedModelProvider# */ getModels: promiseModels }; @@ -91,4 +93,4 @@ define( return PersistedModelProvider; } -); \ No newline at end of file +); diff --git a/platform/core/src/models/RootModelProvider.js b/platform/core/src/models/RootModelProvider.js index 804537ccf2..bf819d51ae 100644 --- a/platform/core/src/models/RootModelProvider.js +++ b/platform/core/src/models/RootModelProvider.js @@ -39,6 +39,7 @@ define( * exposes them all as composition of the root object ROOT, * whose model is also provided by this service. * + * @memberof platform/core * @constructor */ function RootModelProvider(roots, $q, $log) { @@ -68,6 +69,7 @@ define( * containing key-value pairs, * where keys are object identifiers and values * are object models. + * @memberof platform/core.RootModelProvider# */ getModels: function (ids) { return baseProvider.getModels(ids).then(addRoot); @@ -77,4 +79,4 @@ define( return RootModelProvider; } -); \ No newline at end of file +); diff --git a/platform/core/src/models/StaticModelProvider.js b/platform/core/src/models/StaticModelProvider.js index eb946d6d4b..68b76d6b43 100644 --- a/platform/core/src/models/StaticModelProvider.js +++ b/platform/core/src/models/StaticModelProvider.js @@ -31,6 +31,7 @@ define( /** * Loads static models, provided as declared extensions of bundles. + * @memberof platform/core * @constructor */ function StaticModelProvider(models, $q, $log) { @@ -69,6 +70,7 @@ define( * ids and values are models * @method * @memberof StaticModelProvider# + * @memberof platform/core.StaticModelProvider# */ getModels: function (ids) { var result = {}; @@ -82,4 +84,4 @@ define( return StaticModelProvider; } -); \ No newline at end of file +); diff --git a/platform/core/src/objects/DomainObject.js b/platform/core/src/objects/DomainObject.js index e3a10160a5..c36e5db516 100644 --- a/platform/core/src/objects/DomainObject.js +++ b/platform/core/src/objects/DomainObject.js @@ -37,6 +37,7 @@ define( * @param {object} model the "JSONifiable" state of the object * @param {Object.|function} capabilities all * capabilities to be exposed by this object + * @memberof platform/core * @constructor */ function DomainObject(id, model, capabilities) { @@ -45,6 +46,7 @@ define( * Get the unique identifier for this domain object. * @return {string} the domain object's unique identifier * @memberof DomainObject# + * @memberof platform/core.DomainObject# */ getId: function () { return id; @@ -59,6 +61,7 @@ define( * * @return {object} the domain object's persistent state * @memberof DomainObject# + * @memberof platform/core.DomainObject# */ getModel: function () { return model; @@ -73,6 +76,7 @@ define( * @return {Capability} the named capability, or undefined * if not present. * @memberof DomainObject# + * @memberof platform/core.DomainObject# */ getCapability: function (name) { var capability = capabilities[name]; @@ -87,6 +91,7 @@ define( * @param {string} name the name of the capability to * check for * @returns {boolean} true if provided + * @memberof platform/core.DomainObject# */ hasCapability: function hasCapability(name) { return this.getCapability(name) !== undefined; @@ -110,6 +115,7 @@ define( * @param {...*} [arguments] to pass to the invocation * @returns {*} * @memberof DomainObject# + * @memberof platform/core.DomainObject# */ useCapability: function (name) { // Get tail of args to pass to invoke @@ -125,4 +131,4 @@ define( return DomainObject; } -); \ No newline at end of file +); diff --git a/platform/core/src/objects/DomainObjectProvider.js b/platform/core/src/objects/DomainObjectProvider.js index 46e0fbea6a..852afd2847 100644 --- a/platform/core/src/objects/DomainObjectProvider.js +++ b/platform/core/src/objects/DomainObjectProvider.js @@ -38,6 +38,7 @@ define( * which provides capabilities (dynamic behavior) * for domain objects. * @param $q Angular's $q, for promise consolidation + * @memberof platform/core * @constructor */ function DomainObjectProvider(modelService, capabilityService, $q) { @@ -97,6 +98,7 @@ define( * are string identifiers for domain objects, and * values are the corresponding domain objects themselves. * @memberof module:core/object/object-provider.ObjectProvider# + * @memberof platform/core.DomainObjectProvider# */ getObjects: getObjects }; @@ -104,4 +106,4 @@ define( return DomainObjectProvider; } -); \ No newline at end of file +); diff --git a/platform/core/src/services/Now.js b/platform/core/src/services/Now.js index ea78cbd57a..b799d80391 100644 --- a/platform/core/src/services/Now.js +++ b/platform/core/src/services/Now.js @@ -31,12 +31,15 @@ define( * `Date.now()` which can be injected to support testability. * * @returns {Function} a function which returns current system time + * @constructor + * @memberof platform/core */ function Now() { /** * Get the current time. * @returns {number} current time, in milliseconds since * 1970-01-01 00:00:00Z + * @memberof platform/core.Now# */ return function () { return Date.now(); @@ -45,4 +48,4 @@ define( return Now; } -); \ No newline at end of file +); diff --git a/platform/core/src/services/Throttle.js b/platform/core/src/services/Throttle.js index c0493a733a..16b258ba13 100644 --- a/platform/core/src/services/Throttle.js +++ b/platform/core/src/services/Throttle.js @@ -42,6 +42,8 @@ define( * resolve to the returned value of `fn` whenever that is invoked. * * @returns {Function} + * @constructor + * @memberof platform/core */ function Throttle($timeout) { /** @@ -52,6 +54,7 @@ define( * @param {boolean} apply true if a `$apply` call should be * invoked after this function executes; defaults to * `false`. + * @memberof platform/core.Throttle# */ return function (fn, delay, apply) { var activeTimeout; @@ -82,3 +85,4 @@ define( return Throttle; } ); + diff --git a/platform/core/src/services/Topic.js b/platform/core/src/services/Topic.js index f1afafa843..cc57b4314c 100644 --- a/platform/core/src/services/Topic.js +++ b/platform/core/src/services/Topic.js @@ -44,6 +44,8 @@ define( * arguments) are private; each call returns a new instance. * * @returns {Function} + * @constructor + * @memberof platform/core */ function Topic() { var topics = {}; @@ -71,6 +73,7 @@ define( /** * Use and (if necessary) create a new topic. * @param {string} [key] name of the topic to use + * @memberof platform/core.Topic# */ return function (key) { if (arguments.length < 1) { @@ -85,3 +88,4 @@ define( return Topic; } ); + diff --git a/platform/core/src/types/MergeModels.js b/platform/core/src/types/MergeModels.js index 1b5639b823..b3df6d65ae 100644 --- a/platform/core/src/types/MergeModels.js +++ b/platform/core/src/types/MergeModels.js @@ -64,6 +64,8 @@ define( * @param b the second object to be merged * @param merger the merger, as described above * @returns {*} the result of merging `a` and `b` + * @constructor + * @memberof platform/core */ function mergeModels(a, b, merger) { var mergeFunction; @@ -102,4 +104,4 @@ define( return mergeModels; } -); \ No newline at end of file +); diff --git a/platform/core/src/types/TypeCapability.js b/platform/core/src/types/TypeCapability.js index d14cff5caf..ca311aab2a 100644 --- a/platform/core/src/types/TypeCapability.js +++ b/platform/core/src/types/TypeCapability.js @@ -34,6 +34,7 @@ define( * type directly available when working with that object, by way * of a `domainObject.getCapability('type')` invocation. * + * @memberof platform/core * @constructor * @param {TypeService} typeService the service which * provides type information @@ -51,4 +52,4 @@ define( return TypeCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/types/TypeImpl.js b/platform/core/src/types/TypeImpl.js index a6ddd8e8aa..9e5a52d37f 100644 --- a/platform/core/src/types/TypeImpl.js +++ b/platform/core/src/types/TypeImpl.js @@ -42,6 +42,8 @@ define( * key-value pairs describing a type and its * relationship to other types. * @memberof module:core/type/type-impl + * @constructor + * @memberof platform/core */ function TypeImpl(typeDef) { var inheritList = typeDef.inherits || [], @@ -60,6 +62,7 @@ define( * * @returns {string} the key which identifies this type * @memberof module:core/type/type-impl.TypeImpl# + * @memberof platform/core.TypeImpl# */ getKey: function () { return typeDef.key; @@ -71,6 +74,7 @@ define( * * @returns {string} the human-readable name of this type * @memberof module:core/type/type-impl.TypeImpl# + * @memberof platform/core.TypeImpl# */ getName: function () { return typeDef.name; @@ -82,6 +86,7 @@ define( * * @returns {string} the human-readable description of this type * @memberof module:core/type/type-impl.TypeImpl# + * @memberof platform/core.TypeImpl# */ getDescription: function () { return typeDef.description; @@ -94,6 +99,7 @@ define( * * @returns {string} the glyph to be displayed * @memberof module:core/type/type-impl.TypeImpl# + * @memberof platform/core.TypeImpl# */ getGlyph: function () { return typeDef.glyph; @@ -105,6 +111,7 @@ define( * * @return {Array} properties associated with * objects of this type + * @memberof platform/core.TypeImpl# */ getProperties: function () { return (typeDef.properties || []).map(TypeProperty); @@ -114,6 +121,7 @@ define( * this type. * * @return {object} initial domain object model + * @memberof platform/core.TypeImpl# */ getInitialModel: function () { return typeDef.model || {}; @@ -126,6 +134,7 @@ define( * * @returns {object} the raw definition for this type * @memberof module:core/type/type-impl.TypeImpl# + * @memberof platform/core.TypeImpl# */ getDefinition: function () { return typeDef; @@ -141,6 +150,7 @@ define( * object, which this * @returns {boolean} true * @memberof module:core/type/type-impl.TypeImpl# + * @memberof platform/core.TypeImpl# */ instanceOf: function instanceOf(key) { @@ -162,6 +172,7 @@ define( * the type definition's "feature" field. * @param {string} feature a string identifying the feature * @returns {boolean} true if the feature is supported + * @memberof platform/core.TypeImpl# */ hasFeature: function (feature) { return featureSet[feature] || false; @@ -171,4 +182,4 @@ define( return TypeImpl; } -); \ No newline at end of file +); diff --git a/platform/core/src/types/TypeProperty.js b/platform/core/src/types/TypeProperty.js index 50bd1621a1..fb58199c06 100644 --- a/platform/core/src/types/TypeProperty.js +++ b/platform/core/src/types/TypeProperty.js @@ -36,6 +36,7 @@ define( * Instantiate a property associated with domain objects of a * given type. This provides an interface by which * + * @memberof platform/core * @constructor * @memberof module:core/type/type-property */ @@ -114,6 +115,7 @@ define( /** * Retrieve the value associated with this property * from a given model. + * @memberof platform/core.TypeProperty# */ getValue: function (model) { var property = propertyDefinition.property || @@ -133,6 +135,7 @@ define( /** * Set a value associated with this property in * an object's model. + * @memberof platform/core.TypeProperty# */ setValue: function setValue(model, value) { var property = propertyDefinition.property || @@ -153,6 +156,7 @@ define( }, /** * Get the raw definition for this property. + * @memberof platform/core.TypeProperty# */ getDefinition: function () { return propertyDefinition; @@ -162,4 +166,4 @@ define( return TypeProperty; } -); \ No newline at end of file +); diff --git a/platform/core/src/types/TypePropertyConversion.js b/platform/core/src/types/TypePropertyConversion.js index b00df71c72..d390e74108 100644 --- a/platform/core/src/types/TypePropertyConversion.js +++ b/platform/core/src/types/TypePropertyConversion.js @@ -62,6 +62,8 @@ define( /** * Look up an appropriate conversion between form values and model * values, e.g. to numeric values. + * @constructor + * @memberof platform/core */ function TypePropertyConversion(name) { if (name && @@ -82,4 +84,4 @@ define( return TypePropertyConversion; } -); \ No newline at end of file +); diff --git a/platform/core/src/types/TypeProvider.js b/platform/core/src/types/TypeProvider.js index 79d8c8f800..f321cdc0ef 100644 --- a/platform/core/src/types/TypeProvider.js +++ b/platform/core/src/types/TypeProvider.js @@ -55,6 +55,7 @@ define( * * @param {Array} options.definitions the raw type * definitions for this type. + * @memberof platform/core * @constructor * @memberof module:core/type/type-provider */ @@ -154,6 +155,7 @@ define( * promise for an array of all type instances defined * by this service. * @memberof module:core/type/type-provider.TypeProvider# + * @memberof platform/core.TypeProvider# */ listTypes: function () { var self = this; @@ -176,6 +178,7 @@ define( * @returns {Promise} a * promise for a type object identified by this key. * @memberof module:core/type/type-provider.TypeProvider# + * @memberof platform/core.TypeProvider# */ getType: function (key) { return new TypeImpl(lookupTypeDef(key)); @@ -191,4 +194,4 @@ define( } -); \ No newline at end of file +); diff --git a/platform/core/src/views/ViewCapability.js b/platform/core/src/views/ViewCapability.js index 3653cf5ac5..8cdf7eaecb 100644 --- a/platform/core/src/views/ViewCapability.js +++ b/platform/core/src/views/ViewCapability.js @@ -35,6 +35,7 @@ define( * thereabout) which are applicable to a specific domain * object. * + * @memberof platform/core * @constructor */ function ViewCapability(viewService, domainObject) { @@ -44,6 +45,7 @@ define( * this object. * @returns {View[]} an array of view definitions * which are applicable to this object. + * @memberof platform/core.ViewCapability# */ invoke: function () { return viewService.getViews(domainObject); @@ -53,4 +55,4 @@ define( return ViewCapability; } -); \ No newline at end of file +); diff --git a/platform/core/src/views/ViewProvider.js b/platform/core/src/views/ViewProvider.js index 2b82f0f67d..e3e9e550d2 100644 --- a/platform/core/src/views/ViewProvider.js +++ b/platform/core/src/views/ViewProvider.js @@ -55,6 +55,7 @@ define( * The role of a view provider and of a view capability is to * describe what views are available, not how to instantiate them. * + * @memberof platform/core * @constructor * @param {View[]} an array of view definitions */ @@ -145,6 +146,7 @@ define( * @param {DomainObject} domainObject the domain object to view * @returns {View[]} all views which can be used to visualize * this domain object. + * @memberof platform/core.ViewProvider# */ getViews: getViews }; @@ -152,4 +154,4 @@ define( return ViewProvider; } -); \ No newline at end of file +); diff --git a/platform/entanglement/src/actions/CopyAction.js b/platform/entanglement/src/actions/CopyAction.js index aff8b94fb5..33fe826ace 100644 --- a/platform/entanglement/src/actions/CopyAction.js +++ b/platform/entanglement/src/actions/CopyAction.js @@ -31,6 +31,8 @@ define( * deep copy an object to another location of their choosing. * * @implements Action + * @constructor + * @memberof platform/entanglement */ function CopyAction(locationService, copyService, context) { @@ -90,3 +92,4 @@ define( return CopyAction; } ); + diff --git a/platform/entanglement/src/actions/LinkAction.js b/platform/entanglement/src/actions/LinkAction.js index c6b4be100f..42bc446758 100644 --- a/platform/entanglement/src/actions/LinkAction.js +++ b/platform/entanglement/src/actions/LinkAction.js @@ -30,6 +30,8 @@ define( * link an object to another location of their choosing. * * @implements Action + * @constructor + * @memberof platform/entanglement */ function LinkAction(locationService, linkService, context) { @@ -87,3 +89,4 @@ define( return LinkAction; } ); + diff --git a/platform/entanglement/src/actions/MoveAction.js b/platform/entanglement/src/actions/MoveAction.js index 63f1517c56..7a89279766 100644 --- a/platform/entanglement/src/actions/MoveAction.js +++ b/platform/entanglement/src/actions/MoveAction.js @@ -30,6 +30,8 @@ define( * move an object to another location of their choosing. * * @implements Action + * @constructor + * @memberof platform/entanglement */ function MoveAction(locationService, moveService, context) { @@ -88,3 +90,4 @@ define( return MoveAction; } ); + diff --git a/platform/entanglement/src/services/CopyService.js b/platform/entanglement/src/services/CopyService.js index 487568c475..2b6c4063f8 100644 --- a/platform/entanglement/src/services/CopyService.js +++ b/platform/entanglement/src/services/CopyService.js @@ -30,6 +30,8 @@ define( * CopyService provides an interface for deep copying objects from one * location to another. It also provides a method for determining if * an object can be copied to a specific location. + * @constructor + * @memberof platform/entanglement */ function CopyService($q, creationService, policyService) { @@ -46,6 +48,7 @@ define( * create the duplicate in. * @returns {Promise} A promise that is fulfilled when the * duplicate operation has completed. + * @memberof platform/entanglement.CopyService# */ function duplicateObject(domainObject, parent) { var model = JSON.parse(JSON.stringify(domainObject.getModel())); @@ -78,6 +81,7 @@ define( /** * Returns true if `object` can be copied into * `parentCandidate`'s composition. + * @memberof platform/entanglement.CopyService# */ validate: function (object, parentCandidate) { if (!parentCandidate || !parentCandidate.getId) { @@ -94,6 +98,7 @@ define( }, /** * Wrapper, @see {@link duplicateObject} for implementation. + * @memberof platform/entanglement.CopyService# */ perform: function (object, parentObject) { return duplicateObject(object, parentObject); @@ -104,3 +109,4 @@ define( return CopyService; } ); + diff --git a/platform/entanglement/src/services/LinkService.js b/platform/entanglement/src/services/LinkService.js index acecab3b8d..163e80e647 100644 --- a/platform/entanglement/src/services/LinkService.js +++ b/platform/entanglement/src/services/LinkService.js @@ -30,12 +30,15 @@ define( * LinkService provides an interface for linking objects to additional * locations. It also provides a method for determining if an object * can be copied to a specific location. + * @constructor + * @memberof platform/entanglement */ function LinkService(policyService) { return { /** * Returns `true` if `object` can be linked into * `parentCandidate`'s composition. + * @memberof platform/entanglement.LinkService# */ validate: function (object, parentCandidate) { if (!parentCandidate || !parentCandidate.getId) { @@ -58,6 +61,7 @@ define( * * @returns {Promise} A promise that is fulfilled when the * linking operation has completed. + * @memberof platform/entanglement.LinkService# */ perform: function (object, parentObject) { return parentObject.useCapability('mutation', function (model) { @@ -74,3 +78,4 @@ define( return LinkService; } ); + diff --git a/platform/entanglement/src/services/LocationService.js b/platform/entanglement/src/services/LocationService.js index 3e71011503..e4b54183b6 100644 --- a/platform/entanglement/src/services/LocationService.js +++ b/platform/entanglement/src/services/LocationService.js @@ -29,6 +29,8 @@ define( /** * The LocationService allows for easily prompting the user for a * location in the root tree. + * @constructor + * @memberof platform/entanglement */ function LocationService(dialogService) { return { @@ -43,6 +45,7 @@ define( * @param {domainObject} initialLocation - tree location to * display at start * @returns {Promise} promise for a domain object. + * @memberof platform/entanglement.LocationService# */ getLocationFromUser: function (title, label, validate, initialLocation) { var formStructure, @@ -81,3 +84,4 @@ define( return LocationService; } ); + diff --git a/platform/entanglement/src/services/MoveService.js b/platform/entanglement/src/services/MoveService.js index e91d381453..2fbe2d69bf 100644 --- a/platform/entanglement/src/services/MoveService.js +++ b/platform/entanglement/src/services/MoveService.js @@ -30,12 +30,15 @@ define( * MoveService provides an interface for moving objects from one * location to another. It also provides a method for determining if * an object can be copied to a specific location. + * @constructor + * @memberof platform/entanglement */ function MoveService(policyService, linkService) { return { /** * Returns `true` if `object` can be moved into * `parentCandidate`'s composition. + * @memberof platform/entanglement.MoveService# */ validate: function (object, parentCandidate) { var currentParent = object @@ -65,6 +68,7 @@ define( * * @returns {Promise} A promise that is fulfilled when the * move operation has completed. + * @memberof platform/entanglement.MoveService# */ perform: function (object, parentObject) { return linkService @@ -81,3 +85,4 @@ define( return MoveService; } ); + diff --git a/platform/execution/src/WorkerService.js b/platform/execution/src/WorkerService.js index b8f24ee614..616c268e60 100644 --- a/platform/execution/src/WorkerService.js +++ b/platform/execution/src/WorkerService.js @@ -28,6 +28,7 @@ define( /** * Handles the execution of WebWorkers. + * @memberof platform/execution * @constructor */ function WorkerService($window, workers) { @@ -55,6 +56,7 @@ define( * * @param {string} key symbolic identifier for the worker * @returns {Worker} the running Worker + * @memberof platform/execution.WorkerService# */ run: function (key) { var scriptUrl = workerUrls[key]; @@ -66,3 +68,4 @@ define( return WorkerService; } ); + diff --git a/platform/features/events/src/DomainColumn.js b/platform/features/events/src/DomainColumn.js index 95a6222553..c906b45624 100644 --- a/platform/features/events/src/DomainColumn.js +++ b/platform/features/events/src/DomainColumn.js @@ -33,6 +33,7 @@ define( * A column which will report telemetry domain values * (typically, timestamps.) Used by the ScrollingListController. * + * @memberof platform/features/events * @constructor * @param domainMetadata an object with the machine- and human- * readable names for this domain (in `key` and `name` @@ -45,6 +46,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/events.DomainColumn# */ getTitle: function () { return domainMetadata.name; @@ -53,6 +55,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/events.DomainColumn# */ getValue: function (domainObject, data, index) { return telemetryFormatter.formatDomainValue( @@ -64,4 +67,4 @@ define( return DomainColumn; } -); \ No newline at end of file +); diff --git a/platform/features/events/src/EventListController.js b/platform/features/events/src/EventListController.js index 4b90c91b8e..c67e938776 100644 --- a/platform/features/events/src/EventListController.js +++ b/platform/features/events/src/EventListController.js @@ -36,6 +36,7 @@ define( /** * The EventListController is responsible for populating * the contents of the event list view. + * @memberof platform/features/events * @constructor */ function EventListController($scope, formatter) { @@ -131,3 +132,4 @@ define( return EventListController; } ); + diff --git a/platform/features/events/src/EventListPopulator.js b/platform/features/events/src/EventListPopulator.js index 3999fb1ebc..d4e7429d28 100644 --- a/platform/features/events/src/EventListPopulator.js +++ b/platform/features/events/src/EventListPopulator.js @@ -158,4 +158,4 @@ define( return EventListPopulator; } -); \ No newline at end of file +); diff --git a/platform/features/events/src/RangeColumn.js b/platform/features/events/src/RangeColumn.js index 2b11de43c7..56d9231a01 100644 --- a/platform/features/events/src/RangeColumn.js +++ b/platform/features/events/src/RangeColumn.js @@ -33,6 +33,7 @@ define( * A column which will report telemetry range values * (typically, measurements.) Used by the ScrollingListController. * + * @memberof platform/features/events * @constructor * @param rangeMetadata an object with the machine- and human- * readable names for this range (in `key` and `name` @@ -45,6 +46,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/events.RangeColumn# */ getTitle: function () { return rangeMetadata.name; @@ -53,6 +55,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/events.RangeColumn# */ getValue: function (domainObject, data, index) { return telemetryFormatter.formatRangeValue( @@ -64,4 +67,4 @@ define( return RangeColumn; } -); \ No newline at end of file +); diff --git a/platform/features/events/src/directives/MCTDataTable.js b/platform/features/events/src/directives/MCTDataTable.js index c4cb9970e6..e830fbe885 100644 --- a/platform/features/events/src/directives/MCTDataTable.js +++ b/platform/features/events/src/directives/MCTDataTable.js @@ -71,4 +71,4 @@ define( return MCTDataTable; } -); \ No newline at end of file +); diff --git a/platform/features/events/src/policies/MessagesViewPolicy.js b/platform/features/events/src/policies/MessagesViewPolicy.js index 4426872b1e..1458b9d8eb 100644 --- a/platform/features/events/src/policies/MessagesViewPolicy.js +++ b/platform/features/events/src/policies/MessagesViewPolicy.js @@ -31,6 +31,7 @@ define( /** * Policy controlling when the Messages view should be avaliable. + * @memberof platform/features/events * @constructor */ function MessagesViewPolicy() { @@ -52,6 +53,7 @@ define( * @param {Action} action the action * @param domainObject the domain object which will be viewed * @returns {boolean} true if not disallowed + * @memberof platform/features/events.MessagesViewPolicy# */ allow: function (view, domainObject) { // This policy only applies for the Messages view @@ -71,4 +73,4 @@ define( return MessagesViewPolicy; } -); \ No newline at end of file +); diff --git a/platform/features/imagery/src/controllers/ImageryController.js b/platform/features/imagery/src/controllers/ImageryController.js index 72f72f39db..e3d1e3db2b 100644 --- a/platform/features/imagery/src/controllers/ImageryController.js +++ b/platform/features/imagery/src/controllers/ImageryController.js @@ -32,6 +32,8 @@ define( /** * Controller for the "Imagery" view of a domain object which * provides image telemetry. + * @constructor + * @memberof platform/features/imagery */ function ImageryController($scope, telemetryHandler) { var date = "", @@ -83,6 +85,7 @@ define( * Get the time portion (hours, minutes, seconds) of the * timestamp associated with the incoming image telemetry. * @returns {string} the time + * @memberof platform/features/imagery.ImageryController# */ getTime: function () { return time; @@ -91,6 +94,7 @@ define( * Get the date portion (month, year) of the * timestamp associated with the incoming image telemetry. * @returns {string} the date + * @memberof platform/features/imagery.ImageryController# */ getDate: function () { return date; @@ -100,6 +104,7 @@ define( * to the timestamp associated with the incoming image * telemetry. * @returns {string} the time + * @memberof platform/features/imagery.ImageryController# */ getZone: function () { return "UTC"; @@ -107,6 +112,7 @@ define( /** * Get the URL of the image telemetry to display. * @returns {string} URL for telemetry image + * @memberof platform/features/imagery.ImageryController# */ getImageUrl: function () { return imageUrl; @@ -116,6 +122,7 @@ define( * paused, false means not.) * @param {boolean} [state] the state to set * @returns {boolean} the current state + * @memberof platform/features/imagery.ImageryController# */ paused: function (state) { if (arguments.length > 0 && state !== paused) { @@ -131,3 +138,4 @@ define( return ImageryController; } ); + diff --git a/platform/features/imagery/src/directives/MCTBackgroundImage.js b/platform/features/imagery/src/directives/MCTBackgroundImage.js index 3218910db5..9100dce4b8 100644 --- a/platform/features/imagery/src/directives/MCTBackgroundImage.js +++ b/platform/features/imagery/src/directives/MCTBackgroundImage.js @@ -34,6 +34,8 @@ define( * * If `src` is falsy, no image will be displayed (immediately.) * + * @constructor + * @memberof platform/features/imagery */ function MCTBackgroundImage($document) { function link(scope, element, attrs) { @@ -87,3 +89,4 @@ define( return MCTBackgroundImage; } ); + diff --git a/platform/features/imagery/src/policies/ImageryViewPolicy.js b/platform/features/imagery/src/policies/ImageryViewPolicy.js index 40b74d96df..127174d50a 100644 --- a/platform/features/imagery/src/policies/ImageryViewPolicy.js +++ b/platform/features/imagery/src/policies/ImageryViewPolicy.js @@ -29,6 +29,8 @@ define( * Policy preventing the Imagery view from being made available for * domain objects which do not have associated image telemetry. * @implements {Policy} + * @constructor + * @memberof platform/features/imagery */ function ImageryViewPolicy() { function hasImageTelemetry(domainObject) { @@ -57,3 +59,4 @@ define( return ImageryViewPolicy; } ); + diff --git a/platform/features/layout/src/FixedController.js b/platform/features/layout/src/FixedController.js index 42e6b6dbce..4458e988ea 100644 --- a/platform/features/layout/src/FixedController.js +++ b/platform/features/layout/src/FixedController.js @@ -34,6 +34,7 @@ define( * Fixed Position view. It arranges frames according to saved * configuration and provides methods for updating these based on * mouse movement. + * @memberof platform/features/layout * @constructor * @param {Scope} $scope the controller's Angular scope */ @@ -290,6 +291,7 @@ define( * Get the size of the grid, in pixels. The returned array * is in the form `[x, y]`. * @returns {number[]} the grid size + * @memberof platform/features/layout.FixedController# */ getGridSize: function () { return gridSize; @@ -298,6 +300,7 @@ define( * Get an array of elements in this panel; these are * decorated proxies for both selection and display. * @returns {Array} elements in this panel + * @memberof platform/features/layout.FixedController# */ getElements: function () { return elementProxies; @@ -306,6 +309,7 @@ define( * Check if the element is currently selected, or (if no * argument is supplied) get the currently selected element. * @returns {boolean} true if selected + * @memberof platform/features/layout.FixedController# */ selected: function (element) { return selection && ((arguments.length > 0) ? @@ -314,10 +318,12 @@ define( /** * Set the active user selection in this view. * @param element the element to select + * @memberof platform/features/layout.FixedController# */ select: select, /** * Clear the current user selection. + * @memberof platform/features/layout.FixedController# */ clearSelection: function () { if (selection) { @@ -329,6 +335,7 @@ define( /** * Get drag handles. * @returns {Array} drag handles for the current selection + * @memberof platform/features/layout.FixedController# */ handles: function () { return handles; @@ -336,6 +343,7 @@ define( /** * Get the handle to handle dragging to reposition an element. * @returns {FixedDragHandle} the drag handle + * @memberof platform/features/layout.FixedController# */ moveHandle: function () { return moveHandle; @@ -347,3 +355,4 @@ define( return FixedController; } ); + diff --git a/platform/features/layout/src/FixedDragHandle.js b/platform/features/layout/src/FixedDragHandle.js index 7c26e8320b..a72bbbadb6 100644 --- a/platform/features/layout/src/FixedDragHandle.js +++ b/platform/features/layout/src/FixedDragHandle.js @@ -33,6 +33,7 @@ define( /** * Template-displayable drag handle for an element in fixed * position mode. + * @memberof platform/features/layout * @constructor */ function FixedDragHandle(elementHandle, gridSize, update, commit) { @@ -91,22 +92,26 @@ define( /** * Get a CSS style to position this drag handle. * @returns CSS style object (for `ng-style`) + * @memberof platform/features/layout.FixedDragHandle# */ style: getStyle, /** * Start a drag gesture. This should be called when a drag * begins to track initial state. + * @memberof platform/features/layout.FixedDragHandle# */ startDrag: startDrag, /** * Continue a drag gesture; update x/y positions. * @param {number[]} delta x/y pixel difference since drag * started + * @memberof platform/features/layout.FixedDragHandle# */ continueDrag: continueDrag, /** * End a drag gesture. This should be callled when a drag * concludes to trigger commit of changes. + * @memberof platform/features/layout.FixedDragHandle# */ endDrag: endDrag }; @@ -114,4 +119,4 @@ define( return FixedDragHandle; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/FixedProxy.js b/platform/features/layout/src/FixedProxy.js index f78b8711e9..b84985f9d8 100644 --- a/platform/features/layout/src/FixedProxy.js +++ b/platform/features/layout/src/FixedProxy.js @@ -28,6 +28,7 @@ define( /** * Proxy for configuring a fixed position view via the toolbar. + * @memberof platform/features/layout * @constructor * @param {Function} addElementCallback callback to invoke when * elements are created @@ -41,6 +42,7 @@ define( return { /** * Add a new visual element to this view. + * @memberof platform/features/layout.FixedProxy# */ add: function (type) { // Place a configured element into the view configuration @@ -64,4 +66,4 @@ define( return FixedProxy; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/LayoutCompositionPolicy.js b/platform/features/layout/src/LayoutCompositionPolicy.js index 2c46484498..8f9b6ccf31 100644 --- a/platform/features/layout/src/LayoutCompositionPolicy.js +++ b/platform/features/layout/src/LayoutCompositionPolicy.js @@ -29,12 +29,15 @@ define( /** * Defines composition policy for Display Layout objects. * They cannot contain folders. + * @constructor + * @memberof platform/features/layout */ function LayoutCompositionPolicy() { return { /** * Is the type identified by the candidate allowed to * contain the type described by the context? + * @memberof platform/features/layout.LayoutCompositionPolicy# */ allow: function (candidate, context) { var isFolderInLayout = @@ -50,3 +53,4 @@ define( return LayoutCompositionPolicy; } ); + diff --git a/platform/features/layout/src/LayoutController.js b/platform/features/layout/src/LayoutController.js index 643ed952a3..359646b5b7 100644 --- a/platform/features/layout/src/LayoutController.js +++ b/platform/features/layout/src/LayoutController.js @@ -35,6 +35,7 @@ define( * Layout view. It arranges frames according to saved configuration * and provides methods for updating these based on mouse * movement. + * @memberof platform/features/layout * @constructor * @param {Scope} $scope the controller's Angular scope */ @@ -178,6 +179,7 @@ define( * @param {string} id the object identifier * @returns {Object.} an object with * appropriate left, width, etc fields for positioning + * @memberof platform/features/layout.LayoutController# */ getFrameStyle: function (id) { // Called in a loop, so just look up; the "positions" @@ -203,6 +205,7 @@ define( * in the frame being manipulated * @param {number[]} posFactor the position factor * @param {number[]} dimFactor the dimensions factor + * @memberof platform/features/layout.LayoutController# */ startDrag: function (id, posFactor, dimFactor) { activeDragId = id; @@ -218,6 +221,7 @@ define( * @param {number[]} delta the offset, in pixels, * of the current pointer position, relative * to its position when the drag started + * @memberof platform/features/layout.LayoutController# */ continueDrag: function (delta) { if (activeDrag) { @@ -229,6 +233,7 @@ define( /** * End the active drag gesture. This will update the * view configuration. + * @memberof platform/features/layout.LayoutController# */ endDrag: function () { // Write to configuration; this is watched and @@ -254,3 +259,4 @@ define( return LayoutController; } ); + diff --git a/platform/features/layout/src/LayoutDrag.js b/platform/features/layout/src/LayoutDrag.js index cb3b4808be..45f1ad9856 100644 --- a/platform/features/layout/src/LayoutDrag.js +++ b/platform/features/layout/src/LayoutDrag.js @@ -50,6 +50,8 @@ define( * @param {number[]} posFactor the position factor * @param {number[]} dimFactor the dimensions factor * @param {number[]} the size of each grid element, in pixels + * @constructor + * @memberof platform/features/layout */ function LayoutDrag(rawPosition, posFactor, dimFactor, gridSize) { // Convert a delta from pixel coordinates to grid coordinates, @@ -103,6 +105,7 @@ define( * according to the factors supplied in the constructor. * @param {number[]} pixelDelta the offset from the * original position, in pixels + * @memberof platform/features/layout.LayoutDrag# */ getAdjustedPosition: getAdjustedPosition }; @@ -111,4 +114,4 @@ define( return LayoutDrag; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/AccessorMutator.js b/platform/features/layout/src/elements/AccessorMutator.js index 8b96d9cca9..656c4abbcf 100644 --- a/platform/features/layout/src/elements/AccessorMutator.js +++ b/platform/features/layout/src/elements/AccessorMutator.js @@ -38,6 +38,7 @@ define( * in certain ranges; specifically, to keep x/y positions * non-negative in a fixed position view. * + * @memberof platform/features/layout * @constructor * @param {Object} object the object to get/set values upon * @param {string} key the property to get/set @@ -56,4 +57,4 @@ define( return AccessorMutator; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/BoxProxy.js b/platform/features/layout/src/elements/BoxProxy.js index 724c9e21cd..46ec351b1f 100644 --- a/platform/features/layout/src/elements/BoxProxy.js +++ b/platform/features/layout/src/elements/BoxProxy.js @@ -34,6 +34,7 @@ define( * Note that arguments here are meant to match those expected * by `Array.prototype.map` * + * @memberof platform/features/layout * @constructor * @param element the fixed position element, as stored in its * configuration @@ -50,6 +51,7 @@ define( * @memberof BoxProxy * @param {string} fill the new fill color * @returns {string} the fill color + * @memberof platform/features/layout.BoxProxy# */ proxy.fill = new AccessorMutator(element, 'fill'); @@ -58,4 +60,4 @@ define( return BoxProxy; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/ElementFactory.js b/platform/features/layout/src/elements/ElementFactory.js index 5bcafd8529..01cc4be729 100644 --- a/platform/features/layout/src/elements/ElementFactory.js +++ b/platform/features/layout/src/elements/ElementFactory.js @@ -85,6 +85,7 @@ define( * The ElementFactory creates new instances of elements for the * fixed position view, prompting for user input where necessary. * @param {DialogService} dialogService service to request user input + * @memberof platform/features/layout * @constructor */ function ElementFactory(dialogService) { @@ -94,6 +95,7 @@ define( * @param {string} type the type of element to create * @returns {Promise|object} the created element, or a promise * for that element + * @memberof platform/features/layout.ElementFactory# */ createElement: function (type) { var initialState = INITIAL_STATES[type] || {}; @@ -112,4 +114,4 @@ define( return ElementFactory; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/ElementProxies.js b/platform/features/layout/src/elements/ElementProxies.js index 02a69f3888..1443363883 100644 --- a/platform/features/layout/src/elements/ElementProxies.js +++ b/platform/features/layout/src/elements/ElementProxies.js @@ -34,4 +34,4 @@ define( "fixed.text": TextProxy }; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/ElementProxy.js b/platform/features/layout/src/elements/ElementProxy.js index 4591480517..1261104a9e 100644 --- a/platform/features/layout/src/elements/ElementProxy.js +++ b/platform/features/layout/src/elements/ElementProxy.js @@ -48,6 +48,7 @@ define( * Note that arguments here are meant to match those expected * by `Array.prototype.map` * + * @memberof platform/features/layout * @constructor * @param element the fixed position element, as stored in its * configuration @@ -60,6 +61,7 @@ define( return { /** * The element as stored in the view configuration. + * @memberof platform/features/layout.ElementProxy# */ element: element, /** @@ -67,6 +69,7 @@ define( * Units are in fixed position grid space. * @param {number} [x] the new x position (if setting) * @returns {number} the x position + * @memberof platform/features/layout.ElementProxy# */ x: new AccessorMutator(element, 'x', clamp), /** @@ -74,12 +77,14 @@ define( * Units are in fixed position grid space. * @param {number} [y] the new y position (if setting) * @returns {number} the y position + * @memberof platform/features/layout.ElementProxy# */ y: new AccessorMutator(element, 'y', clamp), /** * Get and/or set the stroke color of this element. * @param {string} [stroke] the new stroke color (if setting) * @returns {string} the stroke color + * @memberof platform/features/layout.ElementProxy# */ stroke: new AccessorMutator(element, 'stroke'), /** @@ -87,6 +92,7 @@ define( * Units are in fixed position grid space. * @param {number} [w] the new width (if setting) * @returns {number} the width + * @memberof platform/features/layout.ElementProxy# */ width: new AccessorMutator(element, 'width'), /** @@ -94,12 +100,14 @@ define( * Units are in fixed position grid space. * @param {number} [h] the new height (if setting) * @returns {number} the height + * @memberof platform/features/layout.ElementProxy# */ height: new AccessorMutator(element, 'height'), /** * Change the display order of this element. * @param {string} o where to move this element; * one of "top", "up", "down", or "bottom" + * @memberof platform/features/layout.ElementProxy# */ order: function (o) { var delta = ORDERS[o] || 0, @@ -120,6 +128,7 @@ define( }, /** * Remove this element from the fixed position view. + * @memberof platform/features/layout.ElementProxy# */ remove: function () { if (elements[index] === element) { @@ -129,6 +138,7 @@ define( /** * Get handles to control specific features of this element, * e.g. corner size. + * @memberof platform/features/layout.ElementProxy# */ handles: function () { return handles; @@ -138,4 +148,4 @@ define( return ElementProxy; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/ImageProxy.js b/platform/features/layout/src/elements/ImageProxy.js index bafe1b9b00..28d84a3fa4 100644 --- a/platform/features/layout/src/elements/ImageProxy.js +++ b/platform/features/layout/src/elements/ImageProxy.js @@ -32,6 +32,7 @@ define( * Note that arguments here are meant to match those expected * by `Array.prototype.map` * + * @memberof platform/features/layout * @constructor * @param element the fixed position element, as stored in its * configuration @@ -45,6 +46,7 @@ define( * Get and/or set the displayed text of this element. * @param {string} [text] the new text (if setting) * @returns {string} the text + * @memberof platform/features/layout.ImageProxy# */ proxy.url = new AccessorMutator(element, 'url'); @@ -53,4 +55,4 @@ define( return ImageProxy; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/LineHandle.js b/platform/features/layout/src/elements/LineHandle.js index 6fd4ed84aa..f4178f107b 100644 --- a/platform/features/layout/src/elements/LineHandle.js +++ b/platform/features/layout/src/elements/LineHandle.js @@ -30,6 +30,7 @@ define( * This is used to support drag handles for line elements * in a fixed position view. Field names for opposite ends * are provided to avoid zero-length lines. + * @memberof platform/features/layout * @constructor * @param element the line element * @param {string} xProperty field which stores x position @@ -43,6 +44,7 @@ define( * Get/set the x position of the lower-right corner * of the handle-controlled element, changing size * as necessary. + * @memberof platform/features/layout.LineHandle# */ x: function (value) { if (arguments.length > 0) { @@ -60,6 +62,7 @@ define( * Get/set the y position of the lower-right corner * of the handle-controlled element, changing size * as necessary. + * @memberof platform/features/layout.LineHandle# */ y: function (value) { if (arguments.length > 0) { @@ -79,4 +82,4 @@ define( return LineHandle; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/LineProxy.js b/platform/features/layout/src/elements/LineProxy.js index 92ca96bf76..0051b1d3c1 100644 --- a/platform/features/layout/src/elements/LineProxy.js +++ b/platform/features/layout/src/elements/LineProxy.js @@ -29,6 +29,7 @@ define( /** * Selection/diplay proxy for line elements of a fixed position * view. + * @memberof platform/features/layout * @constructor * @param element the fixed position element, as stored in its * configuration @@ -46,6 +47,7 @@ define( * Get the top-left x coordinate, in grid space, of * this line's bounding box. * @returns {number} the x coordinate + * @memberof platform/features/layout.LineProxy# */ proxy.x = function (v) { var x = Math.min(element.x, element.x2), @@ -61,6 +63,7 @@ define( * Get the top-left y coordinate, in grid space, of * this line's bounding box. * @returns {number} the y coordinate + * @memberof platform/features/layout.LineProxy# */ proxy.y = function (v) { var y = Math.min(element.y, element.y2), @@ -76,6 +79,7 @@ define( * Get the width, in grid space, of * this line's bounding box. * @returns {number} the width + * @memberof platform/features/layout.LineProxy# */ proxy.width = function () { return Math.max(Math.abs(element.x - element.x2), 1); @@ -85,6 +89,7 @@ define( * Get the height, in grid space, of * this line's bounding box. * @returns {number} the height + * @memberof platform/features/layout.LineProxy# */ proxy.height = function () { return Math.max(Math.abs(element.y - element.y2), 1); @@ -95,6 +100,7 @@ define( * the top-left corner, of the first point in this line * segment. * @returns {number} the x position of the first point + * @memberof platform/features/layout.LineProxy# */ proxy.x1 = function () { return element.x - proxy.x(); @@ -105,6 +111,7 @@ define( * the top-left corner, of the first point in this line * segment. * @returns {number} the y position of the first point + * @memberof platform/features/layout.LineProxy# */ proxy.y1 = function () { return element.y - proxy.y(); @@ -115,6 +122,7 @@ define( * the top-left corner, of the second point in this line * segment. * @returns {number} the x position of the second point + * @memberof platform/features/layout.LineProxy# */ proxy.x2 = function () { return element.x2 - proxy.x(); @@ -125,6 +133,7 @@ define( * the top-left corner, of the second point in this line * segment. * @returns {number} the y position of the second point + * @memberof platform/features/layout.LineProxy# */ proxy.y2 = function () { return element.y2 - proxy.y(); @@ -134,6 +143,7 @@ define( * Get element handles for changing the position of end * points of this line. * @returns {LineHandle[]} line handles for both end points + * @memberof platform/features/layout.LineProxy# */ proxy.handles = function () { return handles; @@ -144,4 +154,4 @@ define( return LineProxy; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/ResizeHandle.js b/platform/features/layout/src/elements/ResizeHandle.js index e87ef91059..c8fe59682c 100644 --- a/platform/features/layout/src/elements/ResizeHandle.js +++ b/platform/features/layout/src/elements/ResizeHandle.js @@ -29,6 +29,7 @@ define( * Handle for changing width/height properties of an element. * This is used to support drag handles for different * element types in a fixed position view. + * @memberof platform/features/layout * @constructor */ function ResizeHandle(element, minWidth, minHeight) { @@ -41,6 +42,7 @@ define( * Get/set the x position of the lower-right corner * of the handle-controlled element, changing size * as necessary. + * @memberof platform/features/layout.ResizeHandle# */ x: function (value) { if (arguments.length > 0) { @@ -55,6 +57,7 @@ define( * Get/set the y position of the lower-right corner * of the handle-controlled element, changing size * as necessary. + * @memberof platform/features/layout.ResizeHandle# */ y: function (value) { if (arguments.length > 0) { @@ -71,4 +74,4 @@ define( return ResizeHandle; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/TelemetryProxy.js b/platform/features/layout/src/elements/TelemetryProxy.js index 7397c0e81a..058048eca8 100644 --- a/platform/features/layout/src/elements/TelemetryProxy.js +++ b/platform/features/layout/src/elements/TelemetryProxy.js @@ -35,6 +35,7 @@ define( * Note that arguments here are meant to match those expected * by `Array.prototype.map` * + * @memberof platform/features/layout * @constructor * @param element the fixed position element, as stored in its * configuration @@ -70,4 +71,4 @@ define( return TelemetryProxy; } -); \ No newline at end of file +); diff --git a/platform/features/layout/src/elements/TextProxy.js b/platform/features/layout/src/elements/TextProxy.js index 5e7ce4870d..d3ff832833 100644 --- a/platform/features/layout/src/elements/TextProxy.js +++ b/platform/features/layout/src/elements/TextProxy.js @@ -32,6 +32,7 @@ define( * Note that arguments here are meant to match those expected * by `Array.prototype.map` * + * @memberof platform/features/layout * @constructor * @param element the fixed position element, as stored in its * configuration @@ -45,6 +46,7 @@ define( * Get and/or set the text color of this element. * @param {string} [color] the new text color (if setting) * @returns {string} the text color + * @memberof platform/features/layout.TextProxy# */ proxy.color = new AccessorMutator(element, 'color'); @@ -52,6 +54,7 @@ define( * Get and/or set the displayed text of this element. * @param {string} [text] the new text (if setting) * @returns {string} the text + * @memberof platform/features/layout.TextProxy# */ proxy.text = new AccessorMutator(element, 'text'); @@ -60,4 +63,4 @@ define( return TextProxy; } -); \ No newline at end of file +); diff --git a/platform/features/pages/src/EmbeddedPageController.js b/platform/features/pages/src/EmbeddedPageController.js index a0e08e6549..843492866f 100644 --- a/platform/features/pages/src/EmbeddedPageController.js +++ b/platform/features/pages/src/EmbeddedPageController.js @@ -29,11 +29,14 @@ define( /** * Controller for embedded web pages; serves simply as a * wrapper for `$sce` to mark pages as trusted. + * @constructor + * @memberof platform/features/pages */ function EmbeddedPageController($sce) { return { /** * Alias of `$sce.trustAsResourceUrl`. + * @memberof platform/features/pages.EmbeddedPageController# */ trust: function (url) { return $sce.trustAsResourceUrl(url); @@ -44,4 +47,4 @@ define( return EmbeddedPageController; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/Canvas2DChart.js b/platform/features/plot/src/Canvas2DChart.js index 7587159986..9fcee46123 100644 --- a/platform/features/plot/src/Canvas2DChart.js +++ b/platform/features/plot/src/Canvas2DChart.js @@ -29,6 +29,7 @@ define( /** * Create a new chart which uses Canvas's 2D API for rendering. * + * @memberof platform/features/plot * @constructor * @param {CanvasElement} canvas the canvas object to render upon * @throws {Error} an error is thrown if Canvas's 2D API is unavailable. @@ -66,6 +67,7 @@ define( return { /** * Clear the chart. + * @memberof platform/features/plot.Canvas2DChart# */ clear: function () { width = canvas.width; @@ -78,6 +80,7 @@ define( * vertical dimensions of the chart * @param {number[]} origin the horizontal/vertical * origin of the chart + * @memberof platform/features/plot.Canvas2DChart# */ setDimensions: function (newDimensions, newOrigin) { dimensions = newDimensions; @@ -92,6 +95,7 @@ define( * the line, as an RGBA color where each element * is in the range of 0.0-1.0 * @param {number} points the number of points to draw + * @memberof platform/features/plot.Canvas2DChart# */ drawLine: function (buf, color, points) { var i; @@ -123,6 +127,7 @@ define( * @param {number[]} color the color to use when drawing * the rectangle, as an RGBA color where each element * is in the range of 0.0-1.0 + * @memberof platform/features/plot.Canvas2DChart# */ drawSquare: function (min, max, color) { var x1 = x(min[0]), @@ -138,4 +143,4 @@ define( return Canvas2DChart; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/GLChart.js b/platform/features/plot/src/GLChart.js index a5e52b6f4d..a390cf1153 100644 --- a/platform/features/plot/src/GLChart.js +++ b/platform/features/plot/src/GLChart.js @@ -49,6 +49,7 @@ define( /** * Create a new chart which uses WebGL for rendering. * + * @memberof platform/features/plot * @constructor * @param {CanvasElement} canvas the canvas object to render upon * @throws {Error} an error is thrown if WebGL is unavailable. @@ -115,6 +116,7 @@ define( return { /** * Clear the chart. + * @memberof platform/features/plot.GLChart# */ clear: function () { // Set the viewport size; note that we use the width/height @@ -134,6 +136,7 @@ define( * vertical dimensions of the chart * @param {number[]} origin the horizontal/vertical * origin of the chart + * @memberof platform/features/plot.GLChart# */ setDimensions: function (dimensions, origin) { if (dimensions && dimensions.length > 0 && @@ -151,6 +154,7 @@ define( * the line, as an RGBA color where each element * is in the range of 0.0-1.0 * @param {number} points the number of points to draw + * @memberof platform/features/plot.GLChart# */ drawLine: function (buf, color, points) { doDraw(gl.LINE_STRIP, buf, color, points); @@ -163,6 +167,7 @@ define( * @param {number[]} color the color to use when drawing * the rectangle, as an RGBA color where each element * is in the range of 0.0-1.0 + * @memberof platform/features/plot.GLChart# */ drawSquare: function (min, max, color) { doDraw(gl.TRIANGLE_FAN, new Float32Array( @@ -173,4 +178,4 @@ define( } return GLChart; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/MCTChart.js b/platform/features/plot/src/MCTChart.js index 2ca51b2309..951ca3532b 100644 --- a/platform/features/plot/src/MCTChart.js +++ b/platform/features/plot/src/MCTChart.js @@ -61,6 +61,7 @@ define( * * `color`: The color of the box, as a four-element RGBA * array, where each element is in the range of 0.0-1.0 * + * @memberof platform/features/plot * @constructor */ function MCTChart($interval, $log) { @@ -208,3 +209,4 @@ define( return MCTChart; } ); + diff --git a/platform/features/plot/src/PlotController.js b/platform/features/plot/src/PlotController.js index da1a7a88ab..3c944f362b 100644 --- a/platform/features/plot/src/PlotController.js +++ b/platform/features/plot/src/PlotController.js @@ -50,6 +50,7 @@ define( * * Handling user interactions. * * Deciding what needs to be drawn in the chart area. * + * @memberof platform/features/plot * @constructor */ function PlotController( @@ -190,6 +191,7 @@ define( * for plotting the trace at the specified index. * @param {number} index the index of the trace * @returns {string} the color, in #RRGGBB form + * @memberof platform/features/plot.PlotController# */ getColor: function (index) { return PlotPalette.getStringColor(index); @@ -199,6 +201,7 @@ define( * of its default state (to determine whether back/unzoom * controls should be shown) * @returns {boolean} true if not in default state + * @memberof platform/features/plot.PlotController# */ isZoomed: function () { return modeOptions.getModeHandler().isZoomed(); @@ -206,12 +209,14 @@ define( /** * Undo the most recent pan/zoom change and restore * the prior state. + * @memberof platform/features/plot.PlotController# */ stepBackPanZoom: function () { return modeOptions.getModeHandler().stepBackPanZoom(); }, /** * Undo all pan/zoom changes and restore the initial state. + * @memberof platform/features/plot.PlotController# */ unzoom: function () { return modeOptions.getModeHandler().unzoom(); @@ -219,6 +224,7 @@ define( /** * Get the mode options (Stacked/Overlaid) that are applicable * for this plot. + * @memberof platform/features/plot.PlotController# */ getModeOptions: function () { return modeOptions.getModeOptions(); @@ -226,6 +232,7 @@ define( /** * Get the current mode that is applicable to this plot. This * will include key, name, and glyph fields. + * @memberof platform/features/plot.PlotController# */ getMode: function () { return modeOptions.getMode(); @@ -234,6 +241,7 @@ define( * Set the mode which should be active in this plot. * @param mode one of the mode options returned from * getModeOptions() + * @memberof platform/features/plot.PlotController# */ setMode: function (mode) { modeOptions.setMode(mode); @@ -243,6 +251,7 @@ define( * Get all individual plots contained within this Plot view. * (Multiple may be contained when in Stacked mode). * @returns {SubPlot[]} all subplots in this Plot view + * @memberof platform/features/plot.PlotController# */ getSubPlots: function () { return modeOptions.getModeHandler().getSubPlots(); @@ -251,6 +260,7 @@ define( * Get the CSS class to apply to the legend for this domain * object; this will reflect limit state. * @returns {string} the CSS class + * @memberof platform/features/plot.PlotController# */ getLegendClass: function (telemetryObject) { return limitTracker && @@ -258,10 +268,12 @@ define( }, /** * Explicitly update all plots. + * @memberof platform/features/plot.PlotController# */ update: update, /** * Check if a request is pending (to show the wait spinner) + * @memberof platform/features/plot.PlotController# */ isRequestPending: function () { // Placeholder; this should reflect request state @@ -274,3 +286,4 @@ define( return PlotController; } ); + diff --git a/platform/features/plot/src/SubPlot.js b/platform/features/plot/src/SubPlot.js index 7c74751b27..9cd8b829cf 100644 --- a/platform/features/plot/src/SubPlot.js +++ b/platform/features/plot/src/SubPlot.js @@ -36,6 +36,7 @@ define( * A SubPlot is an individual plot within a Plot View (which * may contain multiple plots, specifically when in Stacked * plot mode.) + * @memberof platform/features/plot * @constructor * @param {DomainObject[]} telemetryObjects the domain objects * which will be plotted in this sub-plot @@ -214,6 +215,7 @@ define( * represented in this sub-plot. * @returns {DomainObject[]} the domain objects which * will have data plotted in this sub-plot + * @memberof platform/features/plot.SubPlot# */ getTelemetryObjects: function () { return telemetryObjects; @@ -223,6 +225,7 @@ define( * template for this sub-plot's domain axis, as prepared * by the PlotTickGenerator. * @returns {Array} tick marks for the domain axis + * @memberof platform/features/plot.SubPlot# */ getDomainTicks: function () { return domainTicks; @@ -232,6 +235,7 @@ define( * template for this sub-plot's range axis, as prepared * by the PlotTickGenerator. * @returns {Array} tick marks for the range axis + * @memberof platform/features/plot.SubPlot# */ getRangeTicks: function () { return rangeTicks; @@ -243,6 +247,7 @@ define( * attribute, and should have the same internal format * expected by that directive. * @return {object} the drawing object + * @memberof platform/features/plot.SubPlot# */ getDrawingObject: function () { return draw; @@ -252,6 +257,7 @@ define( * current mouse position. * @returns {string[]} the displayable domain and range * coordinates over which the mouse is hovered + * @memberof platform/features/plot.SubPlot# */ getHoverCoordinates: function () { return hoverCoordinates; @@ -259,6 +265,7 @@ define( /** * Handle mouse movement over the chart area. * @param $event the mouse event + * @memberof platform/features/plot.SubPlot# */ hover: function ($event) { isHovering = true; @@ -277,6 +284,7 @@ define( /** * Continue a previously-start pan or zoom gesture. * @param $event the mouse event + * @memberof platform/features/plot.SubPlot# */ continueDrag: function ($event) { mousePosition = toMousePosition($event); @@ -292,6 +300,7 @@ define( /** * Initiate a marquee zoom action. * @param $event the mouse event + * @memberof platform/features/plot.SubPlot# */ startDrag: function ($event) { subPlotBounds = $event.target.getBoundingClientRect(); @@ -318,6 +327,7 @@ define( /** * Complete a marquee zoom action. * @param $event the mouse event + * @memberof platform/features/plot.SubPlot# */ endDrag: function ($event) { mousePosition = toMousePosition($event); @@ -338,6 +348,7 @@ define( /** * Update the drawing bounds, marquee box, and * tick marks for this subplot. + * @memberof platform/features/plot.SubPlot# */ update: function () { updateDrawingBounds(); @@ -355,6 +366,7 @@ define( * the value of this to position that marquee box * correctly. * @param {number} value the domain offset + * @memberof platform/features/plot.SubPlot# */ setDomainOffset: function (value) { domainOffset = value; @@ -365,6 +377,7 @@ define( * an argument, set that state. * @param {boolean} [state] the new hovering state * @returns {boolean} the hovering state + * @memberof platform/features/plot.SubPlot# */ isHovering: function (state) { if (state !== undefined) { @@ -379,3 +392,4 @@ define( } ); + diff --git a/platform/features/plot/src/SubPlotFactory.js b/platform/features/plot/src/SubPlotFactory.js index c883a488c2..33eb8fff65 100644 --- a/platform/features/plot/src/SubPlotFactory.js +++ b/platform/features/plot/src/SubPlotFactory.js @@ -31,6 +31,7 @@ define( * in a reference to the telemetryFormatter, which will be * used to represent telemetry values (timestamps or data * values) as human-readable strings. + * @memberof platform/features/plot * @constructor */ function SubPlotFactory(telemetryFormatter) { @@ -44,6 +45,7 @@ define( * @returns {SubPlot} the instantiated sub-plot * @method * @memberof SubPlotFactory + * @memberof platform/features/plot.SubPlotFactory# */ createSubPlot: function (telemetryObjects, panZoomStack) { return new SubPlot( @@ -58,4 +60,4 @@ define( return SubPlotFactory; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotAxis.js b/platform/features/plot/src/elements/PlotAxis.js index a523a7e352..2066b9c1bd 100644 --- a/platform/features/plot/src/elements/PlotAxis.js +++ b/platform/features/plot/src/elements/PlotAxis.js @@ -31,6 +31,7 @@ define( * for the domain or range axis, sufficient to populate * selectors. * + * @memberof platform/features/plot * @constructor * @param {string} axisType the field in metadatas to * look at for axis options; usually one of @@ -70,12 +71,14 @@ define( * an array of objects, where each object contains a * "key" field and a "name" field (for machine- and * human-readable names respectively) + * @memberof platform/features/plot.PlotAxis# */ options: options, /** * The currently chosen option for this axis. An * initial value is provided; this will be updated * directly form the plot template. + * @memberof platform/features/plot.PlotAxis# */ active: options[0] || defaultValue }; @@ -84,4 +87,4 @@ define( return PlotAxis; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotLimitTracker.js b/platform/features/plot/src/elements/PlotLimitTracker.js index 518344a08e..9993ff2144 100644 --- a/platform/features/plot/src/elements/PlotLimitTracker.js +++ b/platform/features/plot/src/elements/PlotLimitTracker.js @@ -34,6 +34,7 @@ define( INITIAL_SIZE = 675; // 1/128 of MAX_POINTS /** + * @memberof platform/features/plot * @constructor * @param {TelemetryHandle} handle the handle to telemetry access * @param {string} range the key to use when looking up range values @@ -66,4 +67,4 @@ define( return PlotLimitTracker; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotLine.js b/platform/features/plot/src/elements/PlotLine.js index df20fffa4c..b9d2df3588 100644 --- a/platform/features/plot/src/elements/PlotLine.js +++ b/platform/features/plot/src/elements/PlotLine.js @@ -70,6 +70,8 @@ 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 */ addPoint: function (domainValue, rangeValue) { var index; @@ -112,4 +114,4 @@ define( return PlotLine; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotLineBuffer.js b/platform/features/plot/src/elements/PlotLineBuffer.js index e51e6e8a61..5cf52ad49d 100644 --- a/platform/features/plot/src/elements/PlotLineBuffer.js +++ b/platform/features/plot/src/elements/PlotLineBuffer.js @@ -31,6 +31,7 @@ define( * @param {number} domainOffset number to subtract from domain values * @param {number} initialSize initial buffer size * @param {number} maxSize maximum buffer size + * @memberof platform/features/plot * @constructor */ function PlotLineBuffer(domainOffset, initialSize, maxSize) { @@ -104,6 +105,7 @@ define( /** * Get the WebGL-displayable buffer of points to plot. * @returns {Float32Array} displayable buffer for this line + * @memberof platform/features/plot.PlotLineBuffer# */ getBuffer: function () { return buffer; @@ -111,6 +113,7 @@ define( /** * Get the number of points stored in this buffer. * @returns {number} the number of points stored + * @memberof platform/features/plot.PlotLineBuffer# */ getLength: function () { return length; @@ -120,6 +123,7 @@ define( * buffer. Unlike range extrema, these will change as the * buffer gets trimmed. * @returns {number[]} min, max domain values + * @memberof platform/features/plot.PlotLineBuffer# */ getDomainExtrema: function () { // Since these are ordered in the buffer, assume @@ -134,6 +138,7 @@ define( * buffer. Note that these values may have been trimmed out at * some point. * @returns {number[]} min, max range values + * @memberof platform/features/plot.PlotLineBuffer# */ getRangeExtrema: function () { return rangeExtrema; @@ -146,6 +151,7 @@ define( * @param {number} count number of values to remove * @param {boolean} [fromEnd] true if the most recent * values should be removed + * @memberof platform/features/plot.PlotLineBuffer# */ trim: function (count, fromEnd) { // If we're removing values from the start... @@ -170,6 +176,7 @@ define( * series * @returns {boolean} true if insertion succeeded; otherwise * false + * @memberof platform/features/plot.PlotLineBuffer# */ insert: function (series, index) { var sz = series.getPointCount(), @@ -211,6 +218,7 @@ define( }, /** * Append a single data point. + * @memberof platform/features/plot.PlotLineBuffer# */ insertPoint: function (domainValue, rangeValue, index) { // Don't allow @@ -241,6 +249,7 @@ define( * occurs, this will return -1. * @param {number} timestamp timestamp to insert * @returns {number} the index for insertion (or -1) + * @memberof platform/features/plot.PlotLineBuffer# */ findInsertionIndex: function (timestamp) { var value = timestamp - domainOffset; @@ -259,3 +268,4 @@ define( return PlotLineBuffer; } ); + diff --git a/platform/features/plot/src/elements/PlotPalette.js b/platform/features/plot/src/elements/PlotPalette.js index 8e61fe2f6e..f003317fec 100644 --- a/platform/features/plot/src/elements/PlotPalette.js +++ b/platform/features/plot/src/elements/PlotPalette.js @@ -78,6 +78,7 @@ define( * by index, in various color formats. All PlotPalette methods are * static, so there is no need for a constructor call; using * this will simply return PlotPalette itself. + * @memberof platform/features/plot * @constructor */ function PlotPalette() { @@ -131,4 +132,4 @@ define( return PlotPalette; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotPanZoomStack.js b/platform/features/plot/src/elements/PlotPanZoomStack.js index 32f3efd27a..66e3593488 100644 --- a/platform/features/plot/src/elements/PlotPanZoomStack.js +++ b/platform/features/plot/src/elements/PlotPanZoomStack.js @@ -37,6 +37,7 @@ define( * along the domain axis, and the second element describes the same * along the range axis. * + * @memberof platform/features/plot * @constructor * @param {number[]} origin the plot's origin, initially * @param {number[]} dimensions the plot's dimensions, initially @@ -91,6 +92,7 @@ define( * panning or zooming relative to the base value has * been applied. * @returns {number} the depth of the stack + * @memberof platform/features/plot.PlotPanZoomStack# */ getDepth: getDepth, @@ -99,6 +101,7 @@ define( * become the active pan-zoom state. * @param {number[]} origin the new origin * @param {number[]} dimensions the new dimensions + * @memberof platform/features/plot.PlotPanZoomStack# */ pushPanZoom: pushPanZoom, @@ -109,6 +112,7 @@ define( * stack, this acts as a no-op (that is, the lowest * pan-zoom state on the stack cannot be popped, to ensure * that some pan-zoom state is always available.) + * @memberof platform/features/plot.PlotPanZoomStack# */ popPanZoom: popPanZoom, @@ -119,6 +123,7 @@ define( * interfering with the user's chosen zoom level. * @param {number[]} origin the base origin * @param {number[]} dimensions the base dimensions + * @memberof platform/features/plot.PlotPanZoomStack# */ setBasePanZoom: setBasePanZoom, @@ -126,6 +131,7 @@ define( * Clear the pan-zoom stack down to its bottom element; * in effect, pop all elements but the last, e.g. to remove * any temporary user modifications to pan-zoom state. + * @memberof platform/features/plot.PlotPanZoomStack# */ clearPanZoom: clearPanZoom, @@ -134,6 +140,7 @@ define( * of the stack), expressed as an object with "origin" and * "dimensions" fields. * @returns {object} the current pan-zoom state + * @memberof platform/features/plot.PlotPanZoomStack# */ getPanZoom: getPanZoom, @@ -141,6 +148,7 @@ define( * Get the current origin, as represented on the top of the * stack. * @returns {number[]} the current plot origin + * @memberof platform/features/plot.PlotPanZoomStack# */ getOrigin: getOrigin, @@ -148,6 +156,7 @@ define( * Get the current dimensions, as represented on the top of * the stack. * @returns {number[]} the current plot dimensions + * @memberof platform/features/plot.PlotPanZoomStack# */ getDimensions: getDimensions }; @@ -155,4 +164,4 @@ define( return PlotPanZoomStack; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotPanZoomStackGroup.js b/platform/features/plot/src/elements/PlotPanZoomStackGroup.js index 6280c42def..ccb3ae3579 100644 --- a/platform/features/plot/src/elements/PlotPanZoomStackGroup.js +++ b/platform/features/plot/src/elements/PlotPanZoomStackGroup.js @@ -32,6 +32,7 @@ define( * remain independent upon the range axis. This supports panning * and zooming in stacked-plot mode (and, importantly, * stepping back through those states.) + * @memberof platform/features/plot * @constructor * @param {number} count the number of stacks to include in this * group @@ -112,6 +113,7 @@ define( * stack, this acts as a no-op (that is, the lowest * pan-zoom state on the stack cannot be popped, to ensure * that some pan-zoom state is always available.) + * @memberof platform/features/plot.PlotPanZoomStackGroup# */ popPanZoom: popPanZoom, @@ -123,6 +125,7 @@ define( * interfering with the user's chosen pan/zoom states. * @param {number[]} origin the base origin * @param {number[]} dimensions the base dimensions + * @memberof platform/features/plot.PlotPanZoomStackGroup# */ setBasePanZoom: setBasePanZoom, @@ -131,6 +134,7 @@ define( * their bottom element; in effect, pop all elements * but the last, e.g. to remove any temporary user * modifications to pan-zoom state. + * @memberof platform/features/plot.PlotPanZoomStackGroup# */ clearPanZoom: clearPanZoom, /** @@ -140,6 +144,7 @@ define( * panning or zooming relative to the base value has * been applied. * @returns {number} the depth of the stacks in this group + * @memberof platform/features/plot.PlotPanZoomStackGroup# */ getDepth: function () { // All stacks are kept in sync, so look up depth @@ -160,6 +165,7 @@ define( * @param {number} index the index of the stack to get * @returns {PlotPanZoomStack} the pan-zoom stack in the * group identified by that index + * @memberof platform/features/plot.PlotPanZoomStackGroup# */ getPanZoomStack: function (index) { return decoratedStacks[index]; @@ -170,4 +176,4 @@ define( return PlotPanZoomStackGroup; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotPosition.js b/platform/features/plot/src/elements/PlotPosition.js index 462e0882fd..30220f56f6 100644 --- a/platform/features/plot/src/elements/PlotPosition.js +++ b/platform/features/plot/src/elements/PlotPosition.js @@ -36,6 +36,7 @@ define( * PlotPosition was instantiated. Care should be taken when retaining * PlotPosition objects across changes to the pan-zoom stack. * + * @memberof platform/features/plot * @constructor * @param {number} x the horizontal pixel position in the plot area * @param {number} y the vertical pixel position in the plot area @@ -68,6 +69,7 @@ define( /** * Get the domain value corresponding to this pixel position. * @returns {number} the domain value + * @memberof platform/features/plot.PlotPosition# */ getDomain: function () { return position[0]; @@ -75,6 +77,7 @@ define( /** * Get the range value corresponding to this pixel position. * @returns {number} the range value + * @memberof platform/features/plot.PlotPosition# */ getRange: function () { return position[1]; @@ -84,6 +87,7 @@ define( * pixel position. * @returns {number[]} an array containing the domain and * the range value, in that order + * @memberof platform/features/plot.PlotPosition# */ getPosition: function () { return position; @@ -94,4 +98,4 @@ define( return PlotPosition; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotPreparer.js b/platform/features/plot/src/elements/PlotPreparer.js index e301b693c0..87049c9198 100644 --- a/platform/features/plot/src/elements/PlotPreparer.js +++ b/platform/features/plot/src/elements/PlotPreparer.js @@ -36,6 +36,7 @@ define( * preparing them to be rendered. It creates a WebGL-plottable * Float32Array for each trace, and tracks the boundaries of the * data sets (since this is convenient to do during the same pass). + * @memberof platform/features/plot * @constructor * @param {Telemetry[]} datas telemetry data objects * @param {string} domain the key to use when looking up domain values @@ -92,6 +93,7 @@ define( * data sets. This is given as a two-element array where the * first element is domain, and second is range. * @returns {number[]} the dimensions which bound this data set + * @memberof platform/features/plot.PlotPreparer# */ getDimensions: function () { return [max[0] - min[0], max[1] - min[1]]; @@ -102,6 +104,7 @@ define( * first element is domain, and second is range. * The domain value here is not adjusted by the domain offset. * @returns {number[]} the origin of this data set's boundary + * @memberof platform/features/plot.PlotPreparer# */ getOrigin: function () { return min; @@ -112,6 +115,7 @@ define( * preparer, in order to minimize loss-of-precision due to * conversion to the 32-bit float format needed by WebGL. * @returns {number} the domain offset + * @memberof platform/features/plot.PlotPreparer# */ getDomainOffset: function () { return domainOffset; @@ -132,6 +136,7 @@ define( * cause aliasing artifacts (particularly for timestamps) * * @returns {Float32Array[]} the buffers for these traces + * @memberof platform/features/plot.PlotPreparer# */ getBuffers: function () { return buffers; @@ -142,4 +147,4 @@ define( return PlotPreparer; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotSeriesWindow.js b/platform/features/plot/src/elements/PlotSeriesWindow.js index 7cfb89601a..bff0710b34 100644 --- a/platform/features/plot/src/elements/PlotSeriesWindow.js +++ b/platform/features/plot/src/elements/PlotSeriesWindow.js @@ -28,6 +28,8 @@ define( /** * Provides a window on a telemetry data series, to support * insertion into a plot line. + * @constructor + * @memberof platform/features/plot */ function PlotSeriesWindow(series, domain, range, start, end) { return { @@ -65,4 +67,4 @@ define( return PlotSeriesWindow; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotTickGenerator.js b/platform/features/plot/src/elements/PlotTickGenerator.js index 714588b31f..024338eb4d 100644 --- a/platform/features/plot/src/elements/PlotTickGenerator.js +++ b/platform/features/plot/src/elements/PlotTickGenerator.js @@ -31,6 +31,7 @@ define( * domain and range axes of the plot, to support the plot * template. * + * @memberof platform/features/plot * @constructor * @param {PlotPanZoomStack} panZoomStack the pan-zoom stack for * this plot, used to determine plot boundaries @@ -62,6 +63,7 @@ define( * Generate tick marks for the domain axis. * @param {number} count the number of ticks * @returns {string[]} labels for those ticks + * @memberof platform/features/plot.PlotTickGenerator# */ generateDomainTicks: function (count) { var panZoom = panZoomStack.getPanZoom(); @@ -77,6 +79,7 @@ define( * Generate tick marks for the range axis. * @param {number} count the number of ticks * @returns {string[]} labels for those ticks + * @memberof platform/features/plot.PlotTickGenerator# */ generateRangeTicks: function (count) { var panZoom = panZoomStack.getPanZoom(); @@ -93,4 +96,4 @@ define( return PlotTickGenerator; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/elements/PlotUpdater.js b/platform/features/plot/src/elements/PlotUpdater.js index caf3abf3a2..d37112c243 100644 --- a/platform/features/plot/src/elements/PlotUpdater.js +++ b/platform/features/plot/src/elements/PlotUpdater.js @@ -39,6 +39,7 @@ define( * preparing them to be rendered. It creates a WebGL-plottable * Float32Array for each trace, and tracks the boundaries of the * data sets (since this is convenient to do during the same pass). + * @memberof platform/features/plot * @constructor * @param {TelemetryHandle} handle the handle to telemetry access * @param {string} domain the key to use when looking up domain values @@ -277,6 +278,7 @@ define( * data sets. This is given as a two-element array where the * first element is domain, and second is range. * @returns {number[]} the dimensions which bound this data set + * @memberof platform/features/plot.PlotUpdater# */ getDimensions: function () { return dimensions; @@ -287,6 +289,7 @@ define( * first element is domain, and second is range. * The domain value here is not adjusted by the domain offset. * @returns {number[]} the origin of this data set's boundary + * @memberof platform/features/plot.PlotUpdater# */ getOrigin: function () { // Pad range if necessary @@ -298,6 +301,7 @@ define( * preparer, in order to minimize loss-of-precision due to * conversion to the 32-bit float format needed by WebGL. * @returns {number} the domain offset + * @memberof platform/features/plot.PlotUpdater# */ getDomainOffset: function () { return domainOffset; @@ -318,16 +322,19 @@ define( * cause aliasing artifacts (particularly for timestamps) * * @returns {Float32Array[]} the buffers for these traces + * @memberof platform/features/plot.PlotUpdater# */ getLineBuffers: function () { return bufferArray; }, /** * Update with latest data. + * @memberof platform/features/plot.PlotUpdater# */ update: update, /** * Fill in historical data. + * @memberof platform/features/plot.PlotUpdater# */ addHistorical: setHistorical }; @@ -337,3 +344,4 @@ define( } ); + diff --git a/platform/features/plot/src/modes/PlotModeOptions.js b/platform/features/plot/src/modes/PlotModeOptions.js index 355f553228..efeea30fb5 100644 --- a/platform/features/plot/src/modes/PlotModeOptions.js +++ b/platform/features/plot/src/modes/PlotModeOptions.js @@ -44,6 +44,7 @@ define( * are applicable in a given plot view, maintains current * selection state thereof, and provides handlers for the * different behaviors associated with these modes. + * @memberof platform/features/plot * @constructor * @param {DomainObject[]} the telemetry objects being * represented in this plot view @@ -61,6 +62,7 @@ define( * and view-level interactions with pan-zoom state. * @returns {PlotOverlayMode|PlotStackMode} a handler * for the current mode + * @memberof platform/features/plot.PlotModeOptions# */ getModeHandler: function () { // Lazily initialize @@ -77,6 +79,7 @@ define( * mode contains a `name` and `glyph` field suitable * for display in a template. * @return {Array} the available modes + * @memberof platform/features/plot.PlotModeOptions# */ getModeOptions: function () { return options; @@ -86,6 +89,7 @@ define( * This will be one of the elements returned from * `getModeOptions`. * @return {object} the current mode + * @memberof platform/features/plot.PlotModeOptions# */ getMode: function () { return mode; @@ -96,6 +100,7 @@ define( * returned by `getModeOptions`. * @param {object} option one of the plot mode options * from `getModeOptions` + * @memberof platform/features/plot.PlotModeOptions# */ setMode: function (option) { if (mode !== option) { @@ -110,4 +115,4 @@ define( return PlotModeOptions; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/modes/PlotOverlayMode.js b/platform/features/plot/src/modes/PlotOverlayMode.js index 501d4b0e78..6baad8a546 100644 --- a/platform/features/plot/src/modes/PlotOverlayMode.js +++ b/platform/features/plot/src/modes/PlotOverlayMode.js @@ -29,6 +29,7 @@ define( /** * Handles plotting in Overlaid mode. In overlaid mode, there * is one sub-plot which contains all plotted objects. + * @memberof platform/features/plot * @constructor * @param {DomainObject[]} the domain objects to be plotted */ @@ -68,12 +69,14 @@ define( /** * Plot telemetry to the sub-plot(s) managed by this mode. * @param {PlotPreparer} prepared the prepared data to plot + * @memberof platform/features/plot.PlotOverlayMode# */ plotTelemetry: plotTelemetry, /** * Get all sub-plots to be displayed in this mode; used * to populate the plot template. * @return {SubPlot[]} all sub-plots to display in this mode + * @memberof platform/features/plot.PlotOverlayMode# */ getSubPlots: function () { return subplots; @@ -83,6 +86,7 @@ define( * there are some temporary user modifications to the * current pan-zoom state.) * @returns {boolean} true if not in the base pan-zoom state + * @memberof platform/features/plot.PlotOverlayMode# */ isZoomed: function () { return panZoomStack.getDepth() > 1; @@ -90,6 +94,7 @@ define( /** * Undo the most recent pan/zoom change and restore * the prior state. + * @memberof platform/features/plot.PlotOverlayMode# */ stepBackPanZoom: function () { panZoomStack.popPanZoom(); @@ -104,4 +109,4 @@ define( return PlotOverlayMode; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/modes/PlotStackMode.js b/platform/features/plot/src/modes/PlotStackMode.js index 5d54b461f1..c64f3fe286 100644 --- a/platform/features/plot/src/modes/PlotStackMode.js +++ b/platform/features/plot/src/modes/PlotStackMode.js @@ -29,6 +29,7 @@ define( /** * Handles plotting in Stacked mode. In stacked mode, there * is one sub-plot for each plotted object. + * @memberof platform/features/plot * @constructor * @param {DomainObject[]} the domain objects to be plotted */ @@ -77,12 +78,14 @@ define( /** * Plot telemetry to the sub-plot(s) managed by this mode. * @param {PlotPreparer} prepared the prepared data to plot + * @memberof platform/features/plot.PlotStackMode# */ plotTelemetry: plotTelemetry, /** * Get all sub-plots to be displayed in this mode; used * to populate the plot template. * @return {SubPlot[]} all sub-plots to display in this mode + * @memberof platform/features/plot.PlotStackMode# */ getSubPlots: function () { return subplots; @@ -92,6 +95,7 @@ define( * there are some temporary user modifications to the * current pan-zoom state.) * @returns {boolean} true if not in the base pan-zoom state + * @memberof platform/features/plot.PlotStackMode# */ isZoomed: function () { return panZoomStackGroup.getDepth() > 1; @@ -99,6 +103,7 @@ define( /** * Undo the most recent pan/zoom change and restore * the prior state. + * @memberof platform/features/plot.PlotStackMode# */ stepBackPanZoom: function () { panZoomStackGroup.popPanZoom(); @@ -108,6 +113,7 @@ define( }, /** * Undo all pan/zoom changes and restore the initial state. + * @memberof platform/features/plot.PlotStackMode# */ unzoom: function () { panZoomStackGroup.clearPanZoom(); @@ -120,4 +126,4 @@ define( return PlotStackMode; } -); \ No newline at end of file +); diff --git a/platform/features/plot/src/policies/PlotViewPolicy.js b/platform/features/plot/src/policies/PlotViewPolicy.js index 78df8c3187..26a64c0101 100644 --- a/platform/features/plot/src/policies/PlotViewPolicy.js +++ b/platform/features/plot/src/policies/PlotViewPolicy.js @@ -29,6 +29,8 @@ define( * Policy preventing the Plot view from being made available for * domain objects which have non-numeric telemetry. * @implements {Policy} + * @constructor + * @memberof platform/features/plot */ function PlotViewPolicy() { function hasImageTelemetry(domainObject) { @@ -63,3 +65,4 @@ define( return PlotViewPolicy; } ); + diff --git a/platform/features/rtevents/src/DomainColumn.js b/platform/features/rtevents/src/DomainColumn.js index 43279a42d7..ea2e039634 100644 --- a/platform/features/rtevents/src/DomainColumn.js +++ b/platform/features/rtevents/src/DomainColumn.js @@ -33,6 +33,7 @@ define( * A column which will report telemetry domain values * (typically, timestamps.) Used by the ScrollingListController. * + * @memberof platform/features/rtevents * @constructor * @param domainMetadata an object with the machine- and human- * readable names for this domain (in `key` and `name` @@ -45,6 +46,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/rtevents.DomainColumn# */ getTitle: function () { // At the moment there does not appear to be a way to get the @@ -55,6 +57,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/rtevents.DomainColumn# */ getValue: function (domainObject, handle) { return { @@ -69,3 +72,4 @@ define( return DomainColumn; } ); + diff --git a/platform/features/rtevents/src/RTEventListController.js b/platform/features/rtevents/src/RTEventListController.js index bed335c6cd..93441f2635 100644 --- a/platform/features/rtevents/src/RTEventListController.js +++ b/platform/features/rtevents/src/RTEventListController.js @@ -35,6 +35,7 @@ define( /** * The RTEventListController is responsible for populating * the contents of the messages view. + * @memberof platform/features/rtevents * @constructor */ function RTEventListController($scope, telemetryHandler, telemetryFormatter) { @@ -136,3 +137,4 @@ define( return RTEventListController; } ); + diff --git a/platform/features/rtevents/src/RangeColumn.js b/platform/features/rtevents/src/RangeColumn.js index 68147062b5..1c398ddd44 100644 --- a/platform/features/rtevents/src/RangeColumn.js +++ b/platform/features/rtevents/src/RangeColumn.js @@ -34,6 +34,7 @@ define( * A column which will report telemetry range values * (typically, measurements.) Used by the RTEventListController. * + * @memberof platform/features/rtevents * @constructor * @param rangeMetadata an object with the machine- and human- * readable names for this range (in `key` and `name` @@ -46,6 +47,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/rtevents.RangeColumn# */ getTitle: function () { return "Message"; @@ -54,6 +56,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/rtevents.RangeColumn# */ getValue: function (domainObject, handle) { return { @@ -66,3 +69,4 @@ define( return RangeColumn; } ); + diff --git a/platform/features/rtevents/src/directives/MCTRTDataTable.js b/platform/features/rtevents/src/directives/MCTRTDataTable.js index 9047d9e7f1..d7337eab4f 100644 --- a/platform/features/rtevents/src/directives/MCTRTDataTable.js +++ b/platform/features/rtevents/src/directives/MCTRTDataTable.js @@ -71,4 +71,4 @@ define( return MCTRTDataTable; } -); \ No newline at end of file +); diff --git a/platform/features/rtevents/src/policies/RTMessagesViewPolicy.js b/platform/features/rtevents/src/policies/RTMessagesViewPolicy.js index e3948e5a5c..a5a2373fb8 100644 --- a/platform/features/rtevents/src/policies/RTMessagesViewPolicy.js +++ b/platform/features/rtevents/src/policies/RTMessagesViewPolicy.js @@ -31,6 +31,7 @@ define( /** * Policy controlling when the real time Messages view should be avaliable. + * @memberof platform/features/rtevents * @constructor */ function RTMessagesViewPolicy() { @@ -52,6 +53,7 @@ define( * @param {Action} action the action * @param domainObject the domain object which will be viewed * @returns {boolean} true if not disallowed + * @memberof platform/features/rtevents.RTMessagesViewPolicy# */ allow: function (view, domainObject) { // This policy only applies for the RT Messages view @@ -71,4 +73,4 @@ define( return RTMessagesViewPolicy; } -); \ No newline at end of file +); diff --git a/platform/features/rtscrolling/src/DomainColumn.js b/platform/features/rtscrolling/src/DomainColumn.js index c4f8a2a143..95f262515d 100644 --- a/platform/features/rtscrolling/src/DomainColumn.js +++ b/platform/features/rtscrolling/src/DomainColumn.js @@ -33,6 +33,7 @@ define( * A column which will report telemetry domain values * (typically, timestamps.) Used by the ScrollingListController. * + * @memberof platform/features/rtscrolling * @constructor * @param domainMetadata an object with the machine- and human- * readable names for this domain (in `key` and `name` @@ -45,6 +46,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/rtscrolling.DomainColumn# */ getTitle: function () { return "Time"; @@ -53,6 +55,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/rtscrolling.DomainColumn# */ getValue: function (domainObject, handle) { return { @@ -67,3 +70,4 @@ define( return DomainColumn; } ); + diff --git a/platform/features/rtscrolling/src/NameColumn.js b/platform/features/rtscrolling/src/NameColumn.js index eb08ebc7ed..b30891341b 100644 --- a/platform/features/rtscrolling/src/NameColumn.js +++ b/platform/features/rtscrolling/src/NameColumn.js @@ -33,6 +33,7 @@ define( * A column which will report the name of the domain object * which exposed specific telemetry values. * + * @memberof platform/features/rtscrolling * @constructor */ function NameColumn() { @@ -40,6 +41,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/rtscrolling.NameColumn# */ getTitle: function () { return "Name"; @@ -48,6 +50,7 @@ define( * Get the text to display inside a row under this * column. This returns the domain object's name. * @returns {string} the text to display + * @memberof platform/features/rtscrolling.NameColumn# */ getValue: function (domainObject) { return { @@ -60,3 +63,4 @@ define( return NameColumn; } ); + diff --git a/platform/features/rtscrolling/src/RTScrollingListController.js b/platform/features/rtscrolling/src/RTScrollingListController.js index bc9f8a63ed..282ccd145c 100644 --- a/platform/features/rtscrolling/src/RTScrollingListController.js +++ b/platform/features/rtscrolling/src/RTScrollingListController.js @@ -34,6 +34,7 @@ define( /** * The RTScrollingListController is responsible for populating * the contents of the scrolling list view. + * @memberof platform/features/rtscrolling * @constructor */ function RTScrollingListController($scope, telemetryHandler, telemetryFormatter) { @@ -135,3 +136,4 @@ define( return RTScrollingListController; } ); + diff --git a/platform/features/rtscrolling/src/RangeColumn.js b/platform/features/rtscrolling/src/RangeColumn.js index 867cc0798c..79c6cb8c73 100644 --- a/platform/features/rtscrolling/src/RangeColumn.js +++ b/platform/features/rtscrolling/src/RangeColumn.js @@ -33,6 +33,7 @@ define( * A column which will report telemetry range values * (typically, measurements.) Used by the RTScrollingListController. * + * @memberof platform/features/rtscrolling * @constructor * @param rangeMetadata an object with the machine- and human- * readable names for this range (in `key` and `name` @@ -52,6 +53,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/rtscrolling.RangeColumn# */ getTitle: function () { return "Value"; @@ -60,6 +62,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/rtscrolling.RangeColumn# */ getValue: function (domainObject, handle) { var range = findRange(domainObject), @@ -81,3 +84,4 @@ define( return RangeColumn; } ); + diff --git a/platform/features/scrolling/src/DomainColumn.js b/platform/features/scrolling/src/DomainColumn.js index 33f3f4e020..96df96f822 100644 --- a/platform/features/scrolling/src/DomainColumn.js +++ b/platform/features/scrolling/src/DomainColumn.js @@ -33,6 +33,7 @@ define( * A column which will report telemetry domain values * (typically, timestamps.) Used by the ScrollingListController. * + * @memberof platform/features/scrolling * @constructor * @param domainMetadata an object with the machine- and human- * readable names for this domain (in `key` and `name` @@ -45,6 +46,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/scrolling.DomainColumn# */ getTitle: function () { return domainMetadata.name; @@ -53,6 +55,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/scrolling.DomainColumn# */ getValue: function (domainObject, datum) { return { @@ -66,4 +69,4 @@ define( return DomainColumn; } -); \ No newline at end of file +); diff --git a/platform/features/scrolling/src/NameColumn.js b/platform/features/scrolling/src/NameColumn.js index 6420c44439..e177f0ceca 100644 --- a/platform/features/scrolling/src/NameColumn.js +++ b/platform/features/scrolling/src/NameColumn.js @@ -33,6 +33,7 @@ define( * A column which will report the name of the domain object * which exposed specific telemetry values. * + * @memberof platform/features/scrolling * @constructor */ function NameColumn() { @@ -40,6 +41,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/scrolling.NameColumn# */ getTitle: function () { return "Name"; @@ -48,6 +50,7 @@ define( * Get the text to display inside a row under this * column. This returns the domain object's name. * @returns {string} the text to display + * @memberof platform/features/scrolling.NameColumn# */ getValue: function (domainObject) { return { @@ -59,4 +62,4 @@ define( return NameColumn; } -); \ No newline at end of file +); diff --git a/platform/features/scrolling/src/RangeColumn.js b/platform/features/scrolling/src/RangeColumn.js index 1e89dfc376..980ed5da39 100644 --- a/platform/features/scrolling/src/RangeColumn.js +++ b/platform/features/scrolling/src/RangeColumn.js @@ -33,6 +33,7 @@ define( * A column which will report telemetry range values * (typically, measurements.) Used by the ScrollingListController. * + * @memberof platform/features/scrolling * @constructor * @param rangeMetadata an object with the machine- and human- * readable names for this range (in `key` and `name` @@ -45,6 +46,7 @@ define( /** * Get the title to display in this column's header. * @returns {string} the title to display + * @memberof platform/features/scrolling.RangeColumn# */ getTitle: function () { return rangeMetadata.name; @@ -53,6 +55,7 @@ define( * Get the text to display inside a row under this * column. * @returns {string} the text to display + * @memberof platform/features/scrolling.RangeColumn# */ getValue: function (domainObject, datum) { var range = rangeMetadata.key, @@ -70,4 +73,4 @@ define( return RangeColumn; } -); \ No newline at end of file +); diff --git a/platform/features/scrolling/src/ScrollingListController.js b/platform/features/scrolling/src/ScrollingListController.js index f61e178964..522a762474 100644 --- a/platform/features/scrolling/src/ScrollingListController.js +++ b/platform/features/scrolling/src/ScrollingListController.js @@ -34,6 +34,7 @@ define( /** * The ScrollingListController is responsible for populating * the contents of the scrolling list view. + * @memberof platform/features/scrolling * @constructor */ function ScrollingListController($scope, formatter) { @@ -130,3 +131,4 @@ define( return ScrollingListController; } ); + diff --git a/platform/features/scrolling/src/ScrollingListPopulator.js b/platform/features/scrolling/src/ScrollingListPopulator.js index bbdda2359a..058829bab0 100644 --- a/platform/features/scrolling/src/ScrollingListPopulator.js +++ b/platform/features/scrolling/src/ScrollingListPopulator.js @@ -30,6 +30,7 @@ define( * The ScrollingListPopulator is responsible for filling in the * values which should appear within columns of a scrolling list * view, based on received telemetry data. + * @memberof platform/features/scrolling * @constructor * @param {Column[]} columns the columns to be populated */ @@ -50,6 +51,7 @@ define( * data objects; expected to be in the same order * as the domain objects provided at constructor * @param {number} count the number of rows to provide + * @memberof platform/features/scrolling.ScrollingListPopulator# */ function getLatestDataValues(datas, count) { var latest = [], @@ -136,6 +138,7 @@ define( * Get the text which should appear in headers for the * provided columns. * @returns {string[]} column headers + * @memberof platform/features/scrolling.ScrollingListPopulator# */ getHeaders: function () { return columns.map(function (column) { @@ -152,6 +155,7 @@ define( * @returns {string[][]} an array of rows, each of which * is an array of values which should appear * in that row + * @memberof platform/features/scrolling.ScrollingListPopulator# */ getRows: function (datas, objects, count) { var values = getLatestDataValues(datas, count); @@ -181,3 +185,4 @@ define( } ); + diff --git a/platform/forms/src/MCTControl.js b/platform/forms/src/MCTControl.js index 8ec0d5e039..b46ba6e7a1 100644 --- a/platform/forms/src/MCTControl.js +++ b/platform/forms/src/MCTControl.js @@ -33,6 +33,8 @@ define( * `controls`; this allows plug-ins to introduce new form * control types while still making use of the form * generator to ensure an overall consistent form style. + * @constructor + * @memberof platform/forms */ function MCTControl(controls) { var controlMap = {}; @@ -103,4 +105,4 @@ define( return MCTControl; } -); \ No newline at end of file +); diff --git a/platform/forms/src/MCTForm.js b/platform/forms/src/MCTForm.js index a318870198..fb288ed244 100644 --- a/platform/forms/src/MCTForm.js +++ b/platform/forms/src/MCTForm.js @@ -46,6 +46,7 @@ define( * of name, except this will be made available in the * parent scope. * + * @memberof platform/forms * @constructor */ function MCTForm() { @@ -82,4 +83,4 @@ define( return MCTForm; } -); \ No newline at end of file +); diff --git a/platform/forms/src/MCTToolbar.js b/platform/forms/src/MCTToolbar.js index ea0f644cc3..41d2c4c00d 100644 --- a/platform/forms/src/MCTToolbar.js +++ b/platform/forms/src/MCTToolbar.js @@ -46,6 +46,7 @@ define( * of name, except this will be made available in the * parent scope. * + * @memberof platform/forms * @constructor */ function MCTForm() { @@ -82,4 +83,4 @@ define( return MCTForm; } -); \ No newline at end of file +); diff --git a/platform/forms/src/controllers/ColorController.js b/platform/forms/src/controllers/ColorController.js index 420e2ed96d..6c1db4fed1 100644 --- a/platform/forms/src/controllers/ColorController.js +++ b/platform/forms/src/controllers/ColorController.js @@ -99,4 +99,4 @@ define( return ColorController; } -); \ No newline at end of file +); diff --git a/platform/forms/src/controllers/CompositeController.js b/platform/forms/src/controllers/CompositeController.js index e332ed7115..e3a0559d09 100644 --- a/platform/forms/src/controllers/CompositeController.js +++ b/platform/forms/src/controllers/CompositeController.js @@ -35,6 +35,7 @@ define( * filled in) should be disallowed. This is enforced in the template * by an ng-required directive, but that is supported by the * isNonEmpty check that this controller provides. + * @memberof platform/forms * @constructor */ function CompositeController() { @@ -55,6 +56,7 @@ define( * @param {Array} value the array to check * @returns {boolean} true if any non-undefined * element is in the array + * @memberof platform/forms.CompositeController# */ isNonEmpty: function (value) { return Array.isArray(value) && @@ -66,4 +68,4 @@ define( return CompositeController; } -); \ No newline at end of file +); diff --git a/platform/forms/src/controllers/DateTimeController.js b/platform/forms/src/controllers/DateTimeController.js index e37e3a8f71..5ef7735ed1 100644 --- a/platform/forms/src/controllers/DateTimeController.js +++ b/platform/forms/src/controllers/DateTimeController.js @@ -34,6 +34,7 @@ define( * input fields but outputs a single timestamp (in * milliseconds since start of 1970) to the ngModel. * + * @memberof platform/forms * @constructor */ function DateTimeController($scope) { @@ -106,3 +107,4 @@ define( } ); + diff --git a/platform/forms/src/controllers/DialogButtonController.js b/platform/forms/src/controllers/DialogButtonController.js index 1298b1a63c..afb0e54391 100644 --- a/platform/forms/src/controllers/DialogButtonController.js +++ b/platform/forms/src/controllers/DialogButtonController.js @@ -29,6 +29,7 @@ define( * Controller for the `dialog-button` control type. Provides * structure for a button (embedded via the template) which * will show a dialog for editing a single property when clicked. + * @memberof platform/forms * @constructor * @param $scope the control's Angular scope * @param {DialogService} dialogService service to use to prompt @@ -85,6 +86,7 @@ define( * `button`; a dialog will be launched when this button * is clicked. * @returns dialog structure + * @memberof platform/forms.DialogButtonController# */ getButtonStructure: function () { return buttonStructure; @@ -94,4 +96,4 @@ define( return DialogButtonController; } -); \ No newline at end of file +); diff --git a/platform/forms/src/controllers/FormController.js b/platform/forms/src/controllers/FormController.js index 12b5261b76..04b8379304 100644 --- a/platform/forms/src/controllers/FormController.js +++ b/platform/forms/src/controllers/FormController.js @@ -31,6 +31,7 @@ define( /** * Controller for mct-form and mct-toolbar directives. + * @memberof platform/forms * @constructor */ function FormController($scope) { @@ -75,4 +76,4 @@ define( return FormController; } -); \ No newline at end of file +); diff --git a/platform/framework/src/Constants.js b/platform/framework/src/Constants.js index 6bfa6ce7b9..3d9fb949b0 100644 --- a/platform/framework/src/Constants.js +++ b/platform/framework/src/Constants.js @@ -47,4 +47,4 @@ define({ "mandatory": Number.POSITIVE_INFINITY }, DEFAULT_PRIORITY: 0 -}); \ No newline at end of file +}); diff --git a/platform/framework/src/FrameworkInitializer.js b/platform/framework/src/FrameworkInitializer.js index 359fd1274f..a0db162f01 100644 --- a/platform/framework/src/FrameworkInitializer.js +++ b/platform/framework/src/FrameworkInitializer.js @@ -38,6 +38,7 @@ define( * * Registering extensions with Angular * * Bootstrapping the Angular application. * + * @memberof platform/framework * @constructor * @param {BundleLoader} loader * @param {BundleResolver} resolver @@ -59,4 +60,4 @@ define( return FrameworkInitializer; } -); \ No newline at end of file +); diff --git a/platform/framework/src/LogLevel.js b/platform/framework/src/LogLevel.js index 5734a66f45..1c54659ff6 100644 --- a/platform/framework/src/LogLevel.js +++ b/platform/framework/src/LogLevel.js @@ -47,6 +47,7 @@ define( * as a default. Only log messages of levels equal to or greater * than the specified level will be passed to console. * + * @memberof platform/framework * @constructor * @param {string} level the logging level */ @@ -83,6 +84,7 @@ define( * * @param app the Angular app to configure * @param $log Angular's $log (also configured) + * @memberof platform/framework.LogLevel# */ configure: function (app, $log) { decorate($log); @@ -98,4 +100,4 @@ define( return LogLevel; } -); \ No newline at end of file +); diff --git a/platform/framework/src/Main.js b/platform/framework/src/Main.js index 2faf115a85..47391a6bb5 100644 --- a/platform/framework/src/Main.js +++ b/platform/framework/src/Main.js @@ -129,4 +129,4 @@ define( requirejs.config({ "baseUrl": "" }); injector.invoke(['$http', '$log', initializeApplication]); } -); \ No newline at end of file +); diff --git a/platform/framework/src/bootstrap/ApplicationBootstrapper.js b/platform/framework/src/bootstrap/ApplicationBootstrapper.js index 8649175091..82b1714e31 100644 --- a/platform/framework/src/bootstrap/ApplicationBootstrapper.js +++ b/platform/framework/src/bootstrap/ApplicationBootstrapper.js @@ -38,6 +38,7 @@ define( * framework needs to wait until all extensions have been loaded * and registered. * + * @memberof platform/framework * @constructor */ function ApplicationBootstrapper(angular, document, $log) { @@ -49,6 +50,7 @@ define( * @memberof ApplicationBootstrapper# * @param {angular.Module} app the Angular application to * bootstrap + * @memberof platform/framework.ApplicationBootstrapper# */ bootstrap: function (app) { $log.info("Bootstrapping application " + (app || {}).name); @@ -61,4 +63,4 @@ define( return ApplicationBootstrapper; } -); \ No newline at end of file +); diff --git a/platform/framework/src/load/Bundle.js b/platform/framework/src/load/Bundle.js index 1a4265fe2c..147ca01ef1 100644 --- a/platform/framework/src/load/Bundle.js +++ b/platform/framework/src/load/Bundle.js @@ -38,6 +38,8 @@ define( * contains resource files used by this bundle * @property {Object.} [extensions={}] * all extensions exposed by this bundle + * @constructor + * @memberof platform/framework */ @@ -84,6 +86,7 @@ define( * Get the path to this bundle. * @memberof Bundle# * @returns {string} + * @memberof platform/framework.Bundle# */ getPath: function () { return path; @@ -97,6 +100,7 @@ define( * @param {string} [sourceFile] optionally, give a path to * a specific source file in the bundle. * @returns {string} + * @memberof platform/framework.Bundle# */ getSourcePath: function (sourceFile) { var subpath = sourceFile ? @@ -114,6 +118,7 @@ define( * @param {string} [resourceFile] optionally, give a path to * a specific resource file in the bundle. * @returns {string} + * @memberof platform/framework.Bundle# */ getResourcePath: function (resourceFile) { var subpath = resourceFile ? @@ -131,6 +136,7 @@ define( * @param {string} [libraryFile] optionally, give a path to * a specific library file in the bundle. * @returns {string} + * @memberof platform/framework.Bundle# */ getLibraryPath: function (libraryFile) { var subpath = libraryFile ? @@ -145,6 +151,7 @@ define( * it will resemble a require.config object. * @memberof Bundle# * @returns {object} + * @memberof platform/framework.Bundle# */ getConfiguration: function () { return definition.configuration || {}; @@ -155,6 +162,7 @@ define( * bundle) and the name (human-readable name for this * bundle.) * @returns {string} log-friendly name for this bundle + * @memberof platform/framework.Bundle# */ getLogName: function () { return logName; @@ -166,6 +174,7 @@ define( * @param category * @memberof Bundle# * @returns {Array} + * @memberof platform/framework.Bundle# */ getExtensions: function (category) { var extensions = definition.extensions[category] || []; @@ -180,6 +189,7 @@ define( * * @memberof Bundle# * @returns {Array} + * @memberof platform/framework.Bundle# */ getExtensionCategories: function () { return Object.keys(definition.extensions); @@ -190,6 +200,7 @@ define( * * @memberof Bundle# * @returns {BundleDefinition} the raw definition of this bundle + * @memberof platform/framework.Bundle# */ getDefinition: function () { return definition; @@ -201,4 +212,4 @@ define( return Bundle; } -); \ No newline at end of file +); diff --git a/platform/framework/src/load/BundleLoader.js b/platform/framework/src/load/BundleLoader.js index 0329681630..34f70b2502 100644 --- a/platform/framework/src/load/BundleLoader.js +++ b/platform/framework/src/load/BundleLoader.js @@ -39,6 +39,7 @@ define( * useful to the framework. This provides the base information which * will be used by later phases of framework layer initialization. * + * @memberof platform/framework * @constructor * @param {object} $http Angular's HTTP requester * @param {object} $log Angular's logging service @@ -120,6 +121,7 @@ define( * @param {string|string[]} an array of bundle names to load, or * the name of a JSON file containing that array * @returns {Promise.} + * @memberof platform/framework.BundleLoader# */ loadBundles: loadBundles }; @@ -127,4 +129,4 @@ define( return BundleLoader; } -); \ No newline at end of file +); diff --git a/platform/framework/src/load/Extension.js b/platform/framework/src/load/Extension.js index 3063838a14..7a2d46ae7b 100644 --- a/platform/framework/src/load/Extension.js +++ b/platform/framework/src/load/Extension.js @@ -38,6 +38,8 @@ define( * @property {string[]} [depends=[]] the dependencies needed by this * extension; these are strings as shall be passed to * Angular's dependency resolution mechanism. + * @constructor + * @memberof platform/framework */ /** @@ -81,6 +83,7 @@ define( * Get the machine-readable identifier for this extension. * * @returns {string} + * @memberof platform/framework.Extension# */ getKey: function () { return definition.key || "undefined"; @@ -90,6 +93,7 @@ define( * * @memberof Extension# * @returns {Bundle} + * @memberof platform/framework.Extension# */ getBundle: function () { return bundle; @@ -100,6 +104,7 @@ define( * * @memberof Extension# * @returns {string} + * @memberof platform/framework.Extension# */ getCategory: function () { return category; @@ -111,6 +116,7 @@ define( * * @returns {boolean} true if an implementation separate * from this definition should also be loaded + * @memberof platform/framework.Extension# */ hasImplementation: function () { return definition.implementation !== undefined; @@ -122,6 +128,7 @@ define( * * @memberof Extension# * @returns {string} path to implementation, or undefined + * @memberof platform/framework.Extension# */ getImplementationPath: function () { return definition.implementation ? @@ -134,6 +141,7 @@ define( * extension) and the name (human-readable name for this * extension.) * @returns {string} log-friendly name for this extension + * @memberof platform/framework.Extension# */ getLogName: function () { return logName; @@ -149,6 +157,7 @@ define( * @returns {ExtensionDefinition} the plain definition of * this extension, as read from the bundle * declaration. + * @memberof platform/framework.Extension# */ getDefinition: function () { return extensionDefinition; @@ -160,4 +169,4 @@ define( return Extension; } -); \ No newline at end of file +); diff --git a/platform/framework/src/register/CustomRegistrars.js b/platform/framework/src/register/CustomRegistrars.js index 5920e4c630..392a8c98c7 100644 --- a/platform/framework/src/register/CustomRegistrars.js +++ b/platform/framework/src/register/CustomRegistrars.js @@ -33,6 +33,7 @@ define( * Handles registration of a few specific extension types that are * understood natively by Angular. This includes services and * directives. + * @memberof platform/framework * @constructor */ function CustomRegistrars(app, $log) { @@ -164,4 +165,4 @@ define( return CustomRegistrars; } -); \ No newline at end of file +); diff --git a/platform/framework/src/register/ExtensionRegistrar.js b/platform/framework/src/register/ExtensionRegistrar.js index cbc44562d0..bc6f58084e 100644 --- a/platform/framework/src/register/ExtensionRegistrar.js +++ b/platform/framework/src/register/ExtensionRegistrar.js @@ -32,6 +32,7 @@ define( /** * Responsible for registering extensions with Angular. * + * @memberof platform/framework * @constructor * @param {angular.Module} the Angular application with which * extensions should be registered @@ -215,6 +216,7 @@ define( * extensions * @returns {angular.Module} the application module with * which extensions were registered + * @memberof platform/framework.ExtensionRegistrar# */ registerExtensions: registerExtensionGroup }; @@ -222,4 +224,4 @@ define( return ExtensionRegistrar; } -); \ No newline at end of file +); diff --git a/platform/framework/src/register/ExtensionSorter.js b/platform/framework/src/register/ExtensionSorter.js index fb401de351..f10d7b62ce 100644 --- a/platform/framework/src/register/ExtensionSorter.js +++ b/platform/framework/src/register/ExtensionSorter.js @@ -34,6 +34,7 @@ define( * specify symbolic properties as strings (instead of numbers), * which will be looked up from the table `Constants.PRIORITY_LEVELS`. * @param $log Angular's logging service + * @memberof platform/framework * @constructor */ function ExtensionSorter($log) { @@ -103,6 +104,7 @@ define( * * @param {object[]} extensions array of resolved extensions * @returns {object[]} the same extensions, in priority order + * @memberof platform/framework.ExtensionSorter# */ sort: function (extensions) { return (extensions || []) @@ -115,4 +117,4 @@ define( return ExtensionSorter; } -); \ No newline at end of file +); diff --git a/platform/framework/src/register/PartialConstructor.js b/platform/framework/src/register/PartialConstructor.js index 3778a2519a..46598f6402 100644 --- a/platform/framework/src/register/PartialConstructor.js +++ b/platform/framework/src/register/PartialConstructor.js @@ -43,6 +43,7 @@ define( * instantiate instances of these extensions by passing only * those per-instance arguments. * + * @memberof platform/framework * @constructor */ function PartialConstructor(Constructor) { @@ -76,4 +77,4 @@ define( return PartialConstructor; } -); \ No newline at end of file +); diff --git a/platform/framework/src/register/ServiceCompositor.js b/platform/framework/src/register/ServiceCompositor.js index d44e8cb24b..c76beeba49 100644 --- a/platform/framework/src/register/ServiceCompositor.js +++ b/platform/framework/src/register/ServiceCompositor.js @@ -33,6 +33,7 @@ define( * Handles service compositing; that is, building up services * from provider, aggregator, and decorator components. * + * @memberof platform/framework * @constructor */ function ServiceCompositor(app, $log) { @@ -221,6 +222,7 @@ define( * method may not behave as expected. * * @param {Array} components extensions of category component + * @memberof platform/framework.ServiceCompositor# */ registerCompositeServices: registerCompositeServices }; @@ -228,4 +230,4 @@ define( return ServiceCompositor; } -); \ No newline at end of file +); diff --git a/platform/framework/src/resolve/BundleResolver.js b/platform/framework/src/resolve/BundleResolver.js index 5c8216da94..02bb76110d 100644 --- a/platform/framework/src/resolve/BundleResolver.js +++ b/platform/framework/src/resolve/BundleResolver.js @@ -34,6 +34,7 @@ define( * initialization. During this phase, any scripts implementing * extensions provided by bundles are loaded. * + * @memberof platform/framework * @constructor */ function BundleResolver(extensionResolver, requireConfigurator, $log) { @@ -47,6 +48,7 @@ define( * * @param {Object.|Array} resolvedBundles * @returns {Object.} + * @memberof platform/framework.BundleResolver# */ function mergeResolvedBundles(resolvedBundles) { var result = {}; @@ -107,6 +109,7 @@ define( * key-value pairs, where keys are extension * categories and values are arrays of resolved * extensions belonging to those categories + * @memberof platform/framework.BundleResolver# */ resolveBundles: function (bundles) { // First, make sure Require is suitably configured @@ -121,4 +124,4 @@ define( return BundleResolver; } -); \ No newline at end of file +); diff --git a/platform/framework/src/resolve/ExtensionResolver.js b/platform/framework/src/resolve/ExtensionResolver.js index 0257664f1f..86eb657f35 100644 --- a/platform/framework/src/resolve/ExtensionResolver.js +++ b/platform/framework/src/resolve/ExtensionResolver.js @@ -35,6 +35,7 @@ define( * * @param {ImplementationLoader} loader used to load implementations * @param {*} $log Angular's logging service + * @memberof platform/framework * @constructor */ function ExtensionResolver(loader, $log) { @@ -111,6 +112,7 @@ define( * will additionally be attached to any loaded implementation. * * @param {Extension} extension + * @memberof platform/framework.ExtensionResolver# */ resolve: function (extension) { // Log that loading has begun @@ -128,4 +130,4 @@ define( return ExtensionResolver; } -); \ No newline at end of file +); diff --git a/platform/framework/src/resolve/ImplementationLoader.js b/platform/framework/src/resolve/ImplementationLoader.js index ce0abe104c..b76c5035e8 100644 --- a/platform/framework/src/resolve/ImplementationLoader.js +++ b/platform/framework/src/resolve/ImplementationLoader.js @@ -33,6 +33,7 @@ define( * Responsible for loading extension implementations * (AMD modules.) Acts as a wrapper around RequireJS to * provide a promise-like API. + * @memberof platform/framework * @constructor * @param {*} require RequireJS, or an object with similar API * @param {*} $log Angular's logging service @@ -57,6 +58,7 @@ define( * @memberof ImplementationLoader# * @param {string} path the path to the module to load * @returns {Promise} a promise for the specified module. + * @memberof platform/framework.ImplementationLoader# */ load: loadModule }; @@ -64,4 +66,4 @@ define( return ImplementationLoader; } -); \ No newline at end of file +); diff --git a/platform/framework/src/resolve/RequireConfigurator.js b/platform/framework/src/resolve/RequireConfigurator.js index 7900efeed9..231a4c316f 100644 --- a/platform/framework/src/resolve/RequireConfigurator.js +++ b/platform/framework/src/resolve/RequireConfigurator.js @@ -30,6 +30,7 @@ define( * Handles configuration of RequireJS to expose libraries * from bundles with module names that can be used from other * bundles. + * @memberof platform/framework * @constructor * @param requirejs an instance of RequireJS */ @@ -99,6 +100,7 @@ define( * * @param {Bundle[]} the bundles to include in this * configuration + * @memberof platform/framework.RequireConfigurator# */ configure: function (bundles) { return requirejs.config(buildConfiguration(bundles)); @@ -109,4 +111,4 @@ define( return RequireConfigurator; } -); \ No newline at end of file +); diff --git a/platform/persistence/cache/src/CachingPersistenceDecorator.js b/platform/persistence/cache/src/CachingPersistenceDecorator.js index 5647f3c9e1..a4ff16c09e 100644 --- a/platform/persistence/cache/src/CachingPersistenceDecorator.js +++ b/platform/persistence/cache/src/CachingPersistenceDecorator.js @@ -31,6 +31,7 @@ define( * that have been loaded, and keeps them in sync after writes. This allows * retrievals to occur more quickly after the first load. * + * @memberof platform/persistence/cache * @constructor * @param {string[]} CACHE_SPACES persistence space names which * should be cached @@ -113,6 +114,7 @@ define( * decorated service. * @memberof CachingPersistenceDecorator# * @returns {Promise.} spaces supported + * @memberof platform/persistence/cache.CachingPersistenceDecorator# */ listSpaces: function () { return persistenceService.listSpaces(); @@ -122,6 +124,7 @@ define( * @memberof CachingPersistenceDecorator# * @param {string} space the space in which to list objects * @returns {Promise.} keys for objects in this space + * @memberof platform/persistence/cache.CachingPersistenceDecorator# */ listObjects: function (space) { return persistenceService.listObjects(space); @@ -136,6 +139,7 @@ define( * @param {object} value a JSONifiable object to store * @returns {Promise.} an indicator of the success or * failure of this request + * @memberof platform/persistence/cache.CachingPersistenceDecorator# */ createObject: function (space, key, value) { addToCache(space, key, value); @@ -150,6 +154,7 @@ define( * @returns {Promise.} a promise for the object; may * resolve to undefined (if the object does not exist * in this space) + * @memberof platform/persistence/cache.CachingPersistenceDecorator# */ readObject: function (space, key) { return (cache[space] && cache[space][key]) ? @@ -167,6 +172,7 @@ define( * @param {object} value a JSONifiable object to store * @returns {Promise.} an indicator of the success or * failure of this request + * @memberof platform/persistence/cache.CachingPersistenceDecorator# */ updateObject: function (space, key, value) { return persistenceService.updateObject(space, key, value) @@ -185,6 +191,7 @@ define( * @param {object} value a JSONifiable object to delete * @returns {Promise.} an indicator of the success or * failure of this request + * @memberof platform/persistence/cache.CachingPersistenceDecorator# */ deleteObject: function (space, key, value) { if (cache[space]) { @@ -198,4 +205,4 @@ define( return CachingPersistenceDecorator; } -); \ No newline at end of file +); diff --git a/platform/persistence/couch/src/CouchDocument.js b/platform/persistence/couch/src/CouchDocument.js index d115f56839..d61641f041 100644 --- a/platform/persistence/couch/src/CouchDocument.js +++ b/platform/persistence/couch/src/CouchDocument.js @@ -33,6 +33,7 @@ define( * metadata field which contains a subset of information found * in the model itself (to support search optimization with * CouchDB views.) + * @memberof platform/persistence/couch * @constructor * @param {string} id the id under which to store this mode * @param {object} model the model to store @@ -59,4 +60,4 @@ define( return CouchDocument; } -); \ No newline at end of file +); diff --git a/platform/persistence/couch/src/CouchIndicator.js b/platform/persistence/couch/src/CouchIndicator.js index f49f6ce2e5..a57a129c21 100644 --- a/platform/persistence/couch/src/CouchIndicator.js +++ b/platform/persistence/couch/src/CouchIndicator.js @@ -55,6 +55,8 @@ define( * Indicator for the current CouchDB connection. Polls CouchDB * at a regular interval (defined by bundle constants) to ensure * that the database is available. + * @constructor + * @memberof platform/persistence/couch */ function CouchIndicator($http, $interval, PATH, INTERVAL) { // Track the current connection state @@ -87,6 +89,7 @@ define( * to display in this indicator. This will return "D", * which should appear as a database icon. * @returns {string} the character of the database icon + * @memberof platform/persistence/couch.CouchIndicator# */ getGlyph: function () { return "D"; @@ -96,6 +99,7 @@ define( * This is used to color the glyph to match its * state (one of ok, caution or err) * @returns {string} the CSS class to apply to this glyph + * @memberof platform/persistence/couch.CouchIndicator# */ getGlyphClass: function () { return state.glyphClass; @@ -103,6 +107,7 @@ define( /** * Get the text that should appear in the indicator. * @returns {string} brief summary of connection status + * @memberof platform/persistence/couch.CouchIndicator# */ getText: function () { return state.text; @@ -111,6 +116,7 @@ define( * Get a longer-form description of the current connection * space, suitable for display in a tooltip * @returns {string} longer summary of connection status + * @memberof platform/persistence/couch.CouchIndicator# */ getDescription: function () { return state.description; @@ -121,4 +127,4 @@ define( return CouchIndicator; } -); \ No newline at end of file +); diff --git a/platform/persistence/couch/src/CouchPersistenceProvider.js b/platform/persistence/couch/src/CouchPersistenceProvider.js index e9dd13e39b..77c8ac7bd8 100644 --- a/platform/persistence/couch/src/CouchPersistenceProvider.js +++ b/platform/persistence/couch/src/CouchPersistenceProvider.js @@ -35,6 +35,7 @@ define( * The CouchPersistenceProvider reads and writes JSON documents * (more specifically, domain object models) to/from a CouchDB * instance. + * @memberof platform/persistence/couch * @constructor */ function CouchPersistenceProvider($http, $q, SPACE, PATH) { @@ -104,6 +105,7 @@ define( * * @returns {Promise.} a promise for a list of * spaces supported by this provider + * @memberof platform/persistence/couch.CouchPersistenceProvider# */ listSpaces: function () { return $q.when(spaces); @@ -114,6 +116,7 @@ define( * @param {string} space the space to check * @returns {Promise.} a promise for the list of * identifiers + * @memberof platform/persistence/couch.CouchPersistenceProvider# */ listObjects: function (space) { return get("_all_docs").then(getIdsFromAllDocs); @@ -127,6 +130,7 @@ define( * @returns {Promise.} a promise for an indication * of the success (true) or failure (false) of this * operation + * @memberof platform/persistence/couch.CouchPersistenceProvider# */ createObject: function (space, key, value) { return put(key, new CouchDocument(key, value)) @@ -141,6 +145,7 @@ define( * @returns {Promise.} a promise for the stored * object; this will resolve to undefined if no such * object is found. + * @memberof platform/persistence/couch.CouchPersistenceProvider# */ readObject: function (space, key) { return get(key).then(getModel); @@ -154,6 +159,7 @@ define( * @returns {Promise.} a promise for an indication * of the success (true) or failure (false) of this * operation + * @memberof platform/persistence/couch.CouchPersistenceProvider# */ updateObject: function (space, key, value) { return put(key, new CouchDocument(key, value, revs[key])) @@ -169,6 +175,7 @@ define( * @returns {Promise.} a promise for an indication * of the success (true) or failure (false) of this * operation + * @memberof platform/persistence/couch.CouchPersistenceProvider# */ deleteObject: function (space, key, value) { return put(key, new CouchDocument(key, value, revs[key], true)) @@ -180,4 +187,4 @@ define( return CouchPersistenceProvider; } -); \ No newline at end of file +); diff --git a/platform/persistence/elastic/src/ElasticIndicator.js b/platform/persistence/elastic/src/ElasticIndicator.js index 82714080a0..17eb4e28db 100644 --- a/platform/persistence/elastic/src/ElasticIndicator.js +++ b/platform/persistence/elastic/src/ElasticIndicator.js @@ -49,6 +49,8 @@ define( * Indicator for the current CouchDB connection. Polls CouchDB * at a regular interval (defined by bundle constants) to ensure * that the database is available. + * @constructor + * @memberof platform/persistence/elastic */ function ElasticIndicator($http, $interval, PATH, INTERVAL) { // Track the current connection state @@ -79,6 +81,7 @@ define( * to display in this indicator. This will return "D", * which should appear as a database icon. * @returns {string} the character of the database icon + * @memberof platform/persistence/elastic.ElasticIndicator# */ getGlyph: function () { return "D"; @@ -88,6 +91,7 @@ define( * This is used to color the glyph to match its * state (one of ok, caution or err) * @returns {string} the CSS class to apply to this glyph + * @memberof platform/persistence/elastic.ElasticIndicator# */ getGlyphClass: function () { return state.glyphClass; @@ -95,6 +99,7 @@ define( /** * Get the text that should appear in the indicator. * @returns {string} brief summary of connection status + * @memberof platform/persistence/elastic.ElasticIndicator# */ getText: function () { return state.text; @@ -103,6 +108,7 @@ define( * Get a longer-form description of the current connection * space, suitable for display in a tooltip * @returns {string} longer summary of connection status + * @memberof platform/persistence/elastic.ElasticIndicator# */ getDescription: function () { return state.description; @@ -113,4 +119,4 @@ define( return ElasticIndicator; } -); \ No newline at end of file +); diff --git a/platform/persistence/elastic/src/ElasticPersistenceProvider.js b/platform/persistence/elastic/src/ElasticPersistenceProvider.js index a9c35af210..dffd13044e 100644 --- a/platform/persistence/elastic/src/ElasticPersistenceProvider.js +++ b/platform/persistence/elastic/src/ElasticPersistenceProvider.js @@ -37,6 +37,7 @@ define( * The ElasticPersistenceProvider reads and writes JSON documents * (more specifically, domain object models) to/from an ElasticSearch * instance. + * @memberof platform/persistence/elastic * @constructor */ function ElasticPersistenceProvider($http, $q, SPACE, ROOT, PATH) { @@ -120,6 +121,7 @@ define( * * @returns {Promise.} a promise for a list of * spaces supported by this provider + * @memberof platform/persistence/elastic.ElasticPersistenceProvider# */ listSpaces: function () { return $q.when(spaces); @@ -130,6 +132,7 @@ define( * @param {string} space the space to check * @returns {Promise.} a promise for the list of * identifiers + * @memberof platform/persistence/elastic.ElasticPersistenceProvider# */ listObjects: function (space) { return $q.when([]); @@ -143,6 +146,7 @@ define( * @returns {Promise.} a promise for an indication * of the success (true) or failure (false) of this * operation + * @memberof platform/persistence/elastic.ElasticPersistenceProvider# */ createObject: function (space, key, value) { return put(key, value).then(checkResponse); @@ -156,6 +160,7 @@ define( * @returns {Promise.} a promise for the stored * object; this will resolve to undefined if no such * object is found. + * @memberof platform/persistence/elastic.ElasticPersistenceProvider# */ readObject: function (space, key) { return get(key).then(getModel); @@ -169,6 +174,7 @@ define( * @returns {Promise.} a promise for an indication * of the success (true) or failure (false) of this * operation + * @memberof platform/persistence/elastic.ElasticPersistenceProvider# */ updateObject: function (space, key, value) { function checkUpdate(response) { @@ -187,6 +193,7 @@ define( * @returns {Promise.} a promise for an indication * of the success (true) or failure (false) of this * operation + * @memberof platform/persistence/elastic.ElasticPersistenceProvider# */ deleteObject: function (space, key, value) { return del(key).then(checkResponse); @@ -197,4 +204,4 @@ define( return ElasticPersistenceProvider; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/PersistenceFailureConstants.js b/platform/persistence/queue/src/PersistenceFailureConstants.js index ca8aa2db25..8eab3d9f4c 100644 --- a/platform/persistence/queue/src/PersistenceFailureConstants.js +++ b/platform/persistence/queue/src/PersistenceFailureConstants.js @@ -26,4 +26,4 @@ define({ OVERWRITE_KEY: "overwrite", TIMESTAMP_FORMAT: "YYYY-MM-DD HH:mm:ss\\Z", UNKNOWN_USER: "unknown user" -}); \ No newline at end of file +}); diff --git a/platform/persistence/queue/src/PersistenceFailureController.js b/platform/persistence/queue/src/PersistenceFailureController.js index 5d503a0f56..54c957b618 100644 --- a/platform/persistence/queue/src/PersistenceFailureController.js +++ b/platform/persistence/queue/src/PersistenceFailureController.js @@ -29,11 +29,14 @@ define( /** * Controller to support the template to be shown in the * dialog shown for persistence failures. + * @constructor + * @memberof platform/persistence/queue */ function PersistenceFailureController() { return { /** * Format a timestamp for display in the dialog. + * @memberof platform/persistence/queue.PersistenceFailureController# */ formatTimestamp: function (timestamp) { return moment.utc(timestamp) @@ -41,6 +44,7 @@ define( }, /** * Format a user name for display in the dialog. + * @memberof platform/persistence/queue.PersistenceFailureController# */ formatUsername: function (username) { return username || Constants.UNKNOWN_USER; @@ -50,4 +54,4 @@ define( return PersistenceFailureController; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/PersistenceFailureDialog.js b/platform/persistence/queue/src/PersistenceFailureDialog.js index 9f976e479c..7b048e7519 100644 --- a/platform/persistence/queue/src/PersistenceFailureDialog.js +++ b/platform/persistence/queue/src/PersistenceFailureDialog.js @@ -41,6 +41,8 @@ define( /** * Populates a `dialogModel` to pass to `dialogService.getUserChoise` * in order to choose between Overwrite and Cancel. + * @constructor + * @memberof platform/persistence/queue */ function PersistenceFailureDialog(failures) { var revisionErrors = [], @@ -72,4 +74,4 @@ define( return PersistenceFailureDialog; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/PersistenceFailureHandler.js b/platform/persistence/queue/src/PersistenceFailureHandler.js index 32e12efa66..cb2b039e23 100644 --- a/platform/persistence/queue/src/PersistenceFailureHandler.js +++ b/platform/persistence/queue/src/PersistenceFailureHandler.js @@ -121,6 +121,8 @@ define( * to overwrite/cancel as appropriate. * @param {Array} failures persistence failures, as prepared * by PersistenceQueueHandler + * @constructor + * @memberof platform/persistence/queue */ handle: handleFailures }; @@ -128,4 +130,4 @@ define( return PersistenceFailureHandler; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/PersistenceQueue.js b/platform/persistence/queue/src/PersistenceQueue.js index a54765f6c7..e704dafe71 100644 --- a/platform/persistence/queue/src/PersistenceQueue.js +++ b/platform/persistence/queue/src/PersistenceQueue.js @@ -50,6 +50,8 @@ define( * persistence when the queue is flushed * @param {number} [DELAY] optional; delay in milliseconds between * attempts to flush the queue + * @constructor + * @memberof platform/persistence/queue */ function PersistenceQueue( $q, @@ -74,4 +76,4 @@ define( return PersistenceQueue; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/PersistenceQueueHandler.js b/platform/persistence/queue/src/PersistenceQueueHandler.js index c57133beb8..2965edfc80 100644 --- a/platform/persistence/queue/src/PersistenceQueueHandler.js +++ b/platform/persistence/queue/src/PersistenceQueueHandler.js @@ -34,6 +34,8 @@ define( * @param $q Angular's $q, for promises * @param {PersistenceFailureHandler} handler to invoke in the event * that a persistence attempt fails. + * @constructor + * @memberof platform/persistence/queue */ function PersistenceQueueHandler($q, failureHandler) { @@ -98,6 +100,7 @@ define( * associated domain objects, in id->object pairs. * @param {PersistenceQueue} queue the persistence queue, * to requeue as necessary + * @memberof platform/persistence/queue.PersistenceQueueHandler# */ persist: function (persistences, domainObjects, queue) { var ids = Object.keys(persistences); @@ -108,4 +111,4 @@ define( return PersistenceQueueHandler; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/PersistenceQueueImpl.js b/platform/persistence/queue/src/PersistenceQueueImpl.js index b0e28becd5..d0c77ee057 100644 --- a/platform/persistence/queue/src/PersistenceQueueImpl.js +++ b/platform/persistence/queue/src/PersistenceQueueImpl.js @@ -41,6 +41,8 @@ define( * persistence when the queue is flushed * @param {number} [DELAY] optional; delay in milliseconds between * attempts to flush the queue + * @constructor + * @memberof platform/persistence/queue */ function PersistenceQueueImpl($q, $timeout, handler, DELAY) { var self, @@ -118,6 +120,7 @@ define( * @param {DomainObject} domainObject the domain object * @param {PersistenceCapability} persistence the object's * undecorated persistence capability + * @memberof platform/persistence/queue.PersistenceQueueImpl# */ put: function (domainObject, persistence) { var id = domainObject.getId(); @@ -132,4 +135,4 @@ define( return PersistenceQueueImpl; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/QueuingPersistenceCapability.js b/platform/persistence/queue/src/QueuingPersistenceCapability.js index 7eb98ba3a9..8fe006504a 100644 --- a/platform/persistence/queue/src/QueuingPersistenceCapability.js +++ b/platform/persistence/queue/src/QueuingPersistenceCapability.js @@ -34,6 +34,8 @@ define( * capability * @param {DomainObject} domainObject the domain object which exposes * the capability + * @constructor + * @memberof platform/persistence/queue */ function QueuingPersistenceCapability(queue, persistence, domainObject) { var queuingPersistence = Object.create(persistence); @@ -48,4 +50,4 @@ define( return QueuingPersistenceCapability; } -); \ No newline at end of file +); diff --git a/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js b/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js index 78643f2908..b60d316407 100644 --- a/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js +++ b/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js @@ -35,6 +35,7 @@ define( * will be handled in batches (allowing failure notification to * also be presented in batches.) * + * @memberof platform/persistence/queue * @constructor */ function QueuingPersistenceCapabilityDecorator( @@ -87,6 +88,7 @@ define( * @returns {Object.} all * capabilities known to be valid for this model, as * key-value pairs + * @memberof platform/persistence/queue.QueuingPersistenceCapabilityDecorator# */ getCapabilities: getCapabilities }; @@ -94,4 +96,4 @@ define( return QueuingPersistenceCapabilityDecorator; } -); \ No newline at end of file +); diff --git a/platform/policy/src/PolicyActionDecorator.js b/platform/policy/src/PolicyActionDecorator.js index da15828da9..9b86a2692f 100644 --- a/platform/policy/src/PolicyActionDecorator.js +++ b/platform/policy/src/PolicyActionDecorator.js @@ -31,6 +31,8 @@ define( * @param {PolicyService} policyService the service which provides * policy decisions * @param {ActionService} actionService the service to decorate + * @constructor + * @memberof platform/policy */ function PolicyActionDecorator(policyService, actionService) { return { @@ -40,6 +42,7 @@ define( * are deemed inapplicable by policy. * @param context the context in which the action will occur * @returns {Action[]} applicable actions + * @memberof platform/policy.PolicyActionDecorator# */ getActions: function (context) { // Check if an action is allowed by policy. @@ -55,4 +58,4 @@ define( return PolicyActionDecorator; } -); \ No newline at end of file +); diff --git a/platform/policy/src/PolicyProvider.js b/platform/policy/src/PolicyProvider.js index 50397b7f1f..228b4c47ef 100644 --- a/platform/policy/src/PolicyProvider.js +++ b/platform/policy/src/PolicyProvider.js @@ -30,6 +30,7 @@ define( * Provides an implementation of `policyService` which consults * various policy extensions to determine whether or not a specific * decision should be allowed. + * @memberof platform/policy * @constructor */ function PolicyProvider(policies) { @@ -74,6 +75,7 @@ define( * was disallowed (if its disallowed) * @returns {boolean} true if the decision is allowed, * otherwise false. + * @memberof platform/policy.PolicyProvider# */ allow: function (category, candidate, context, callback) { var policyList = policyMap[category] || [], @@ -103,4 +105,4 @@ define( return PolicyProvider; } -); \ No newline at end of file +); diff --git a/platform/policy/src/PolicyViewDecorator.js b/platform/policy/src/PolicyViewDecorator.js index 1fd6503649..d1570ffa4e 100644 --- a/platform/policy/src/PolicyViewDecorator.js +++ b/platform/policy/src/PolicyViewDecorator.js @@ -31,6 +31,8 @@ define( * @param {PolicyService} policyService the service which provides * policy decisions * @param {ViewService} viewService the service to decorate + * @constructor + * @memberof platform/policy */ function PolicyActionDecorator(policyService, viewService) { return { @@ -40,6 +42,7 @@ define( * are deemed inapplicable by policy. * @param {DomainObject} the domain object to view * @returns {View[]} applicable views + * @memberof platform/policy.PolicyViewDecorator# */ getViews: function (domainObject) { // Check if an action is allowed by policy. @@ -55,4 +58,4 @@ define( return PolicyActionDecorator; } -); \ No newline at end of file +); diff --git a/platform/representation/src/MCTInclude.js b/platform/representation/src/MCTInclude.js index 41a319e259..dc00c8b89d 100644 --- a/platform/representation/src/MCTInclude.js +++ b/platform/representation/src/MCTInclude.js @@ -49,6 +49,7 @@ define( * an output) and `parameters` is meant to be useful for * display parameterization (more like an input.) * + * @memberof platform/representation * @constructor * @param {TemplateDefinition[]} templates an array of * template extensions @@ -92,3 +93,4 @@ define( return MCTInclude; } ); + diff --git a/platform/representation/src/MCTRepresentation.js b/platform/representation/src/MCTRepresentation.js index 97194f12c3..1fba543d22 100644 --- a/platform/representation/src/MCTRepresentation.js +++ b/platform/representation/src/MCTRepresentation.js @@ -47,6 +47,7 @@ define( * * `parameters`, used to communicate display parameters to * the included template (e.g. title.) * + * @memberof platform/representation * @constructor * @param {RepresentationDefinition[]} representations an array of * representation extensions @@ -238,3 +239,4 @@ define( return MCTRepresentation; } ); + diff --git a/platform/representation/src/actions/ContextMenuAction.js b/platform/representation/src/actions/ContextMenuAction.js index 390531053e..9544f26ca9 100644 --- a/platform/representation/src/actions/ContextMenuAction.js +++ b/platform/representation/src/actions/ContextMenuAction.js @@ -39,6 +39,7 @@ define( /** * Launches a custom context menu for the domain object it contains. * + * @memberof platform/representation * @constructor * @param $compile Angular's $compile service * @param $document the current document @@ -113,4 +114,4 @@ define( return ContextMenuAction; } -); \ No newline at end of file +); diff --git a/platform/representation/src/gestures/ContextMenuGesture.js b/platform/representation/src/gestures/ContextMenuGesture.js index cfab655442..a0de0cce85 100644 --- a/platform/representation/src/gestures/ContextMenuGesture.js +++ b/platform/representation/src/gestures/ContextMenuGesture.js @@ -33,6 +33,7 @@ define( * Add listeners to a representation such that it calls the * context menu action for the domain object it contains. * + * @memberof platform/representation * @constructor * @param element the jqLite-wrapped element which should exhibit * the context mennu @@ -54,6 +55,7 @@ define( * Detach any event handlers associated with this gesture. * @method * @memberof ContextMenuGesture + * @memberof platform/representation.ContextMenuGesture# */ destroy: function () { element.off('contextmenu', stop); @@ -63,4 +65,4 @@ define( return ContextMenuGesture; } -); \ No newline at end of file +); diff --git a/platform/representation/src/gestures/DragGesture.js b/platform/representation/src/gestures/DragGesture.js index bb67732d0a..6a4dfb0d63 100644 --- a/platform/representation/src/gestures/DragGesture.js +++ b/platform/representation/src/gestures/DragGesture.js @@ -33,6 +33,7 @@ define( * Add event handlers to a representation such that it may be * dragged as the source for drag-drop composition. * + * @memberof platform/representation * @constructor * @param $log Angular's logging service * @param element the jqLite-wrapped element which should become @@ -108,6 +109,7 @@ define( * Detach any event handlers associated with this gesture. * @memberof DragGesture * @method + * @memberof platform/representation.DragGesture# */ destroy: function () { // Detach listener @@ -120,4 +122,4 @@ define( return DragGesture; } -); \ No newline at end of file +); diff --git a/platform/representation/src/gestures/DropGesture.js b/platform/representation/src/gestures/DropGesture.js index 25bee716cf..7afffc3c03 100644 --- a/platform/representation/src/gestures/DropGesture.js +++ b/platform/representation/src/gestures/DropGesture.js @@ -33,6 +33,7 @@ define( * A DropGesture adds and maintains event handlers upon an element * such that it may act as a drop target for drag-drop composition. + * @memberof platform/representation * @constructor * @param $q Angular's $q, for promise handling * @param element the jqLite-wrapped representation element @@ -124,6 +125,7 @@ define( return { /** * Detach any event handlers associated with this gesture. + * @memberof platform/representation.DropGesture# */ destroy: function () { element.off('dragover', dragOver); @@ -136,4 +138,4 @@ define( return DropGesture; } -); \ No newline at end of file +); diff --git a/platform/representation/src/gestures/GestureConstants.js b/platform/representation/src/gestures/GestureConstants.js index 2cdba87d0b..811e942c84 100644 --- a/platform/representation/src/gestures/GestureConstants.js +++ b/platform/representation/src/gestures/GestureConstants.js @@ -29,6 +29,8 @@ define({ * The string identifier for the data type used for drag-and-drop * composition of domain objects. (e.g. in event.dataTransfer.setData * calls.) + * @constructor + * @memberof platform/representation */ MCT_DRAG_TYPE: 'mct-domain-object-id', /** @@ -46,4 +48,4 @@ define({ * Identifier for drop events. */ MCT_DROP_EVENT: 'mctDrop' -}); \ No newline at end of file +}); diff --git a/platform/representation/src/gestures/GestureProvider.js b/platform/representation/src/gestures/GestureProvider.js index 797a00aa10..255c33a28f 100644 --- a/platform/representation/src/gestures/GestureProvider.js +++ b/platform/representation/src/gestures/GestureProvider.js @@ -40,6 +40,7 @@ define( * intermediary between these and the `mct-representation` directive * where they are used. * + * @memberof platform/representation * @constructor * @param {Gesture[]} gestures an array of all gestures which are * available as extensions @@ -100,6 +101,7 @@ define( * @return {{ destroy: function }} an object with a `destroy` * method which can (and should) be used when a * gesture should no longer be applied to an element. + * @memberof platform/representation.GestureProvider# */ attachGestures: attachGestures }; @@ -107,4 +109,4 @@ define( return GestureProvider; } -); \ No newline at end of file +); diff --git a/platform/representation/src/gestures/GestureRepresenter.js b/platform/representation/src/gestures/GestureRepresenter.js index 57084c102f..db74d923eb 100644 --- a/platform/representation/src/gestures/GestureRepresenter.js +++ b/platform/representation/src/gestures/GestureRepresenter.js @@ -37,6 +37,8 @@ define( * gestures * @param {Scope} scope the Angular scope for this representation * @param element the JQLite-wrapped mct-representation element + * @constructor + * @memberof platform/representation */ function GestureRepresenter(gestureService, scope, element) { var gestureHandle; @@ -69,10 +71,12 @@ define( * definition of the representation in use * @param {DomainObject} domainObject the domain object * being represented + * @memberof platform/representation.GestureRepresenter# */ represent: represent, /** * Release any resources associated with this representer. + * @memberof platform/representation.GestureRepresenter# */ destroy: destroy }; @@ -80,4 +84,4 @@ define( return GestureRepresenter; } -); \ No newline at end of file +); diff --git a/platform/representation/src/services/DndService.js b/platform/representation/src/services/DndService.js index 0497c2bbfd..b8c4ae7bfe 100644 --- a/platform/representation/src/services/DndService.js +++ b/platform/representation/src/services/DndService.js @@ -32,6 +32,7 @@ define( * * Storing arbitrary JavaScript objects (not just strings.) * * Allowing inspection of dragged objects during `dragover` events, * etc. (which cannot be done in Chrome for security reasons) + * @memberof platform/representation * @constructor * @param $log Angular's $log service */ @@ -43,6 +44,7 @@ define( * Set drag data associated with a given type. * @param {string} key the type's identiifer * @param {*} value the data being dragged + * @memberof platform/representation.DndService# */ setData: function (key, value) { $log.debug("Setting drag data for " + key); @@ -51,6 +53,7 @@ define( /** * Get drag data associated with a given type. * @returns {*} the data being dragged + * @memberof platform/representation.DndService# */ getData: function (key) { return data[key]; @@ -58,6 +61,7 @@ define( /** * Remove data associated with active drags. * @param {string} key the type to remove + * @memberof platform/representation.DndService# */ removeData: function (key) { $log.debug("Clearing drag data for " + key); @@ -68,4 +72,4 @@ define( return DndService; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetryAggregator.js b/platform/telemetry/src/TelemetryAggregator.js index 11c2802e52..8a30e4bc2f 100644 --- a/platform/telemetry/src/TelemetryAggregator.js +++ b/platform/telemetry/src/TelemetryAggregator.js @@ -33,6 +33,7 @@ define( * A telemetry aggregator makes many telemetry providers * appear as one. * + * @memberof platform/telemetry * @constructor */ function TelemetryAggregator($q, telemetryProviders) { @@ -84,6 +85,7 @@ define( * @returns {Promise} a promise for telemetry data * which may (or may not, depending on * availability) satisfy the requests + * @memberof platform/telemetry.TelemetryAggregator# */ requestTelemetry: requestTelemetry, /** @@ -100,6 +102,7 @@ define( * requests to be subscribed upon * @returns {Function} a function which can be called * to unsubscribe + * @memberof platform/telemetry.TelemetryAggregator# */ subscribe: subscribe }; @@ -107,4 +110,4 @@ define( return TelemetryAggregator; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetryCapability.js b/platform/telemetry/src/TelemetryCapability.js index 473aafcdb9..041379e497 100644 --- a/platform/telemetry/src/TelemetryCapability.js +++ b/platform/telemetry/src/TelemetryCapability.js @@ -41,6 +41,7 @@ define( * for a specific object, and for unwrapping the response (to get * at the specific data which is appropriate to the domain object.) * + * @memberof platform/telemetry * @constructor */ function TelemetryCapability($injector, $q, $log, domainObject) { @@ -151,12 +152,14 @@ define( * specific request * @returns {Promise} a promise for the resulting telemetry * object + * @memberof platform/telemetry.TelemetryCapability# */ requestData: requestTelemetry, /** * Get metadata about this domain object's associated * telemetry. + * @memberof platform/telemetry.TelemetryCapability# */ getMetadata: function () { // metadata just looks like a request, @@ -174,6 +177,7 @@ define( * containing the data will be given as an argument. * @param {TelemetryRequest} [request] parameters for the * subscription request + * @memberof platform/telemetry.TelemetryCapability# */ subscribe: subscribe }; @@ -191,3 +195,4 @@ define( return TelemetryCapability; } ); + diff --git a/platform/telemetry/src/TelemetryController.js b/platform/telemetry/src/TelemetryController.js index 504ec2ec4a..3334baf48d 100644 --- a/platform/telemetry/src/TelemetryController.js +++ b/platform/telemetry/src/TelemetryController.js @@ -34,6 +34,7 @@ define( * which need to issue requests for telemetry data and use the * results * + * @memberof platform/telemetry * @constructor */ function TelemetryController($scope, $q, $timeout, $log) { @@ -314,6 +315,7 @@ define( * given index will correspond to the telemetry-providing * domain object at the same index. * @returns {Array} an array of metadata objects + * @memberof platform/telemetry.TelemetryController# */ getMetadata: function () { return self.metadatas; @@ -328,6 +330,7 @@ define( * given index will correspond to the telemetry-providing * domain object at the same index. * @returns {DomainObject[]} an array of metadata objects + * @memberof platform/telemetry.TelemetryController# */ getTelemetryObjects: function () { return self.telemetryObjects; @@ -345,6 +348,7 @@ define( * response at a given index will correspond to the * telemetry-providing domain object at the same index. * @returns {Array} an array of responses + * @memberof platform/telemetry.TelemetryController# */ getResponse: function getResponse(arg) { var id = arg && (typeof arg === 'string' ? @@ -364,6 +368,7 @@ define( * show user feedback, such as a wait spinner. * * @returns {boolean} true if the request is still outstanding + * @memberof platform/telemetry.TelemetryController# */ isRequestPending: function () { return self.pending > 0; @@ -372,6 +377,7 @@ define( * Issue a new data request. This will change the * request parameters that are passed along to all * telemetry capabilities managed by this controller. + * @memberof platform/telemetry.TelemetryController# */ requestData: function (request) { self.request = request || {}; @@ -382,6 +388,7 @@ define( * perform its polling activity. * @param {number} durationMillis the interval at * which to poll, in milliseconds + * @memberof platform/telemetry.TelemetryController# */ setRefreshInterval: function (durationMillis) { self.interval = durationMillis; @@ -392,4 +399,4 @@ define( return TelemetryController; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetryDelegator.js b/platform/telemetry/src/TelemetryDelegator.js index 50fee40ad1..865503154d 100644 --- a/platform/telemetry/src/TelemetryDelegator.js +++ b/platform/telemetry/src/TelemetryDelegator.js @@ -29,6 +29,8 @@ define( /** * Used to handle telemetry delegation associated with a * given domain object. + * @constructor + * @memberof platform/telemetry */ function TelemetryDelegator($q) { return { @@ -38,6 +40,7 @@ define( * or the objects it delegates) * @returns {Promise.} domain objects with * a telemetry capability + * @memberof platform/telemetry.TelemetryDelegator# */ promiseTelemetryObjects: function (domainObject) { // If object has been cleared, there are no relevant @@ -63,4 +66,4 @@ define( return TelemetryDelegator; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetryFormatter.js b/platform/telemetry/src/TelemetryFormatter.js index 853db642d7..277ad0ca24 100644 --- a/platform/telemetry/src/TelemetryFormatter.js +++ b/platform/telemetry/src/TelemetryFormatter.js @@ -35,6 +35,7 @@ define( * The TelemetryFormatter is responsible for formatting (as text * for display) values along either the domain (usually time) or * the range (usually value) of a data series. + * @memberof platform/telemetry * @constructor */ function TelemetryFormatter() { @@ -56,6 +57,7 @@ define( * be treated as a standard timestamp. * @returns {string} a textual representation of the * data and time, suitable for display. + * @memberof platform/telemetry.TelemetryFormatter# */ formatDomainValue: formatDomainValue, /** @@ -66,6 +68,7 @@ define( * be treated as a numeric value. * @returns {string} a textual representation of the * value, suitable for display. + * @memberof platform/telemetry.TelemetryFormatter# */ formatRangeValue: formatRangeValue }; @@ -73,4 +76,4 @@ define( return TelemetryFormatter; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetryHandle.js b/platform/telemetry/src/TelemetryHandle.js index e93b606aeb..145edfc5d7 100644 --- a/platform/telemetry/src/TelemetryHandle.js +++ b/platform/telemetry/src/TelemetryHandle.js @@ -34,6 +34,8 @@ define( * @param $q Angular's $q, for promises * @param {TelemetrySubscription} subscription a subscription * to supplied telemetry + * @constructor + * @memberof platform/telemetry */ function TelemetryHandle($q, subscription) { var seriesMap = {}, @@ -67,6 +69,7 @@ define( * data associated with it * @return {TelemetrySeries} the most recent telemetry series * (or undefined if there is not one) + * @memberof platform/telemetry.TelemetryHandle# */ self.getSeries = function (domainObject) { var id = domainObject.getId(); @@ -81,6 +84,7 @@ define( * @param {Function} [callback] a callback that will be * invoked as new data becomes available, with the * domain object for which new data is available. + * @memberof platform/telemetry.TelemetryHandle# */ self.request = function (request, callback) { // Issue (and handle) the new request from this object @@ -109,4 +113,4 @@ define( return TelemetryHandle; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetryHandler.js b/platform/telemetry/src/TelemetryHandler.js index 9b56bbc41e..f600f52cb7 100644 --- a/platform/telemetry/src/TelemetryHandler.js +++ b/platform/telemetry/src/TelemetryHandler.js @@ -31,6 +31,7 @@ define( * A TelemetryRequester provides an easy interface to request * telemetry associated with a set of domain objects. * + * @memberof platform/telemetry * @constructor * @param $q Angular's $q */ @@ -51,4 +52,4 @@ define( return TelemetryHandler; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetryQueue.js b/platform/telemetry/src/TelemetryQueue.js index cf82d08ff8..b5da77d717 100644 --- a/platform/telemetry/src/TelemetryQueue.js +++ b/platform/telemetry/src/TelemetryQueue.js @@ -32,6 +32,7 @@ define( * a queued series of large objects, ensuring that no value is * overwritten (but consolidated non-overlapping keys into single * objects.) + * @memberof platform/telemetry * @constructor */ function TelemetryQueue() { @@ -102,6 +103,7 @@ define( /** * Check if any value groups remain in this pool. * @return {boolean} true if value groups remain + * @memberof platform/telemetry.TelemetryQueue# */ isEmpty: function () { return queue.length < 1; @@ -112,6 +114,7 @@ define( * where keys and values correspond to the arguments * given to previous put functions. * @return {object} key-value pairs + * @memberof platform/telemetry.TelemetryQueue# */ poll: function () { // Decrement counts for the object that will be popped @@ -122,6 +125,7 @@ define( * Put a key-value pair into the pool. * @param {string} key the key to store the value under * @param {*} value the value to store + * @memberof platform/telemetry.TelemetryQueue# */ put: function (key, value) { getFreeObject(key)[key] = value; @@ -131,4 +135,4 @@ define( return TelemetryQueue; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetrySubscriber.js b/platform/telemetry/src/TelemetrySubscriber.js index e106968828..7f8a6fd58e 100644 --- a/platform/telemetry/src/TelemetrySubscriber.js +++ b/platform/telemetry/src/TelemetrySubscriber.js @@ -38,6 +38,7 @@ define( * (e.g. for telemetry panels) as well as latest-value * extraction. * + * @memberof platform/telemetry * @constructor * @param $q Angular's $q * @param $timeout Angular's $timeout @@ -62,6 +63,7 @@ define( * * @method * @memberof TelemetrySubscriber + * @memberof platform/telemetry.TelemetrySubscriber# */ subscribe: function (domainObject, callback, lossless) { return new TelemetrySubscription( @@ -77,4 +79,4 @@ define( return TelemetrySubscriber; } -); \ No newline at end of file +); diff --git a/platform/telemetry/src/TelemetrySubscription.js b/platform/telemetry/src/TelemetrySubscription.js index 4f7b8379d1..b4ecdd4770 100644 --- a/platform/telemetry/src/TelemetrySubscription.js +++ b/platform/telemetry/src/TelemetrySubscription.js @@ -38,6 +38,7 @@ define( * (e.g. for telemetry panels) as well as latest-value * extraction. * + * @memberof platform/telemetry * @constructor * @param $q Angular's $q * @param $timeout Angular's $timeout @@ -227,6 +228,7 @@ define( * with this object. * @method * @memberof TelemetrySubscription + * @memberof platform/telemetry.TelemetrySubscription# */ unsubscribe: function () { if (unlistenToMutation) { @@ -247,6 +249,7 @@ define( * @returns the most recent domain value observed * @method * @memberof TelemetrySubscription + * @memberof platform/telemetry.TelemetrySubscription# */ getDomainValue: function (domainObject) { var id = domainObject.getId(); @@ -265,6 +268,7 @@ define( * @returns the most recent range value observed * @method * @memberof TelemetrySubscription + * @memberof platform/telemetry.TelemetrySubscription# */ getRangeValue: function (domainObject) { var id = domainObject.getId(); @@ -275,6 +279,7 @@ define( * * @param {DomainObject} domainObject the object of interest * @returns {TelemetryDatum} the most recent datum + * @memberof platform/telemetry.TelemetrySubscription# */ getDatum: function (domainObject) { var id = domainObject.getId(); @@ -294,6 +299,7 @@ define( * @returns {DomainObject[]} all subscribed-to domain objects * @method * @memberof TelemetrySubscription + * @memberof platform/telemetry.TelemetrySubscription# */ getTelemetryObjects: function () { return telemetryObjects; @@ -309,6 +315,7 @@ define( * given index will correspond to the telemetry-providing * domain object at the same index. * @returns {Array} an array of metadata objects + * @memberof platform/telemetry.TelemetrySubscription# */ getMetadata: function () { return metadatas; @@ -318,6 +325,7 @@ define( * associated with this subscription. * @returns {Promise.} a promise for * telemetry-providing objects + * @memberof platform/telemetry.TelemetrySubscription# */ promiseTelemetryObjects: function () { // Unsubscribe promise is available after objects @@ -331,3 +339,4 @@ define( } ); + diff --git a/platform/telemetry/src/TelemetryTable.js b/platform/telemetry/src/TelemetryTable.js index d70febed2f..c992a3ec18 100644 --- a/platform/telemetry/src/TelemetryTable.js +++ b/platform/telemetry/src/TelemetryTable.js @@ -32,6 +32,7 @@ define( * one large object, overwriting new values as necessary. Stands * in contrast to the TelemetryQueue, which will avoid overwriting * values. + * @memberof platform/telemetry * @constructor */ function TelemetryTable() { @@ -41,6 +42,7 @@ define( /** * Check if any value groups remain in this pool. * @return {boolean} true if value groups remain + * @memberof platform/telemetry.TelemetryTable# */ isEmpty: function () { return !table; @@ -51,6 +53,7 @@ define( * where keys and values correspond to the arguments * given to previous put functions. * @return {object} key-value pairs + * @memberof platform/telemetry.TelemetryTable# */ poll: function () { var t = table; @@ -61,6 +64,7 @@ define( * Put a key-value pair into the pool. * @param {string} key the key to store the value under * @param {*} value the value to store + * @memberof platform/telemetry.TelemetryTable# */ put: function (key, value) { table = table || {}; @@ -71,4 +75,4 @@ define( return TelemetryTable; } -); \ No newline at end of file +);