From 31eb366e7fbaeae15172d999f4721308204ada2e Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Fri, 7 Aug 2015 12:13:15 -0700
Subject: [PATCH] [JSDoc] Add namespace docs

WTD-1482.
---
 platform/commonUI/about/src/AboutController.js             | 5 +++++
 platform/commonUI/browse/src/BrowseController.js           | 3 ++-
 platform/commonUI/dialog/src/DialogService.js              | 4 +++-
 platform/commonUI/edit/src/controllers/EditController.js   | 3 ++-
 platform/commonUI/general/src/StyleSheetLoader.js          | 5 +++++
 platform/commonUI/inspect/src/InfoConstants.js             | 7 +++++++
 platform/containment/src/CompositionPolicy.js              | 5 +++++
 platform/core/src/objects/DomainObjectProvider.js          | 4 +++-
 platform/entanglement/src/services/LocationService.js      | 5 +++++
 platform/execution/src/WorkerService.js                    | 6 ++++++
 platform/features/events/src/EventListController.js        | 7 ++++++-
 .../features/imagery/src/controllers/ImageryController.js  | 4 ++++
 platform/features/layout/src/LayoutController.js           | 5 +++++
 platform/features/pages/src/EmbeddedPageController.js      | 5 +++++
 platform/features/plot/src/PlotController.js               | 3 ++-
 platform/features/scrolling/src/ScrollingListController.js | 3 ++-
 platform/forms/src/MCTForm.js                              | 4 +++-
 platform/framework/src/Main.js                             | 5 +++++
 .../persistence/cache/src/CachingPersistenceDecorator.js   | 5 +++++
 platform/persistence/couch/src/CouchPersistenceProvider.js | 5 +++++
 .../persistence/elastic/src/ElasticPersistenceProvider.js  | 5 +++++
 .../queue/src/QueuingPersistenceCapabilityDecorator.js     | 5 ++++-
 platform/policy/src/PolicyProvider.js                      | 4 ++++
 platform/representation/src/MCTRepresentation.js           | 4 +++-
 platform/representation/src/gestures/GestureConstants.js   | 1 -
 platform/telemetry/src/TelemetryAggregator.js              | 4 +++-
 26 files changed, 104 insertions(+), 12 deletions(-)

diff --git a/platform/commonUI/about/src/AboutController.js b/platform/commonUI/about/src/AboutController.js
index b2fce0bdfd..c40df7e824 100644
--- a/platform/commonUI/about/src/AboutController.js
+++ b/platform/commonUI/about/src/AboutController.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+
+/**
+ * Implements Open MCT Web's About dialog.
+ * @namespace platform/commonUI/about
+ */
 define(
     [],
     function () {
diff --git a/platform/commonUI/browse/src/BrowseController.js b/platform/commonUI/browse/src/BrowseController.js
index 7d65db507d..b10e0a598a 100644
--- a/platform/commonUI/browse/src/BrowseController.js
+++ b/platform/commonUI/browse/src/BrowseController.js
@@ -22,7 +22,8 @@
 /*global define,Promise*/
 
 /**
- * Module defining BrowseController. Created by vwoeltje on 11/7/14.
+ * This bundle implements Browse mode.
+ * @namespace platform/commonUI/browse
  */
 define(
     [],
diff --git a/platform/commonUI/dialog/src/DialogService.js b/platform/commonUI/dialog/src/DialogService.js
index a435d287e5..e23d0d7c8e 100644
--- a/platform/commonUI/dialog/src/DialogService.js
+++ b/platform/commonUI/dialog/src/DialogService.js
@@ -22,7 +22,9 @@
 /*global define*/
 
 /**
- * Module defining DialogService. Created by vwoeltje on 11/10/14.
+ * This bundle implements the dialog service, which can be used to
+ * launch dialogs for user input & notifications.
+ * @namespace platform/commonUI/dialog
  */
 define(
     [],
diff --git a/platform/commonUI/edit/src/controllers/EditController.js b/platform/commonUI/edit/src/controllers/EditController.js
index f0f2822207..9b0c228ac3 100644
--- a/platform/commonUI/edit/src/controllers/EditController.js
+++ b/platform/commonUI/edit/src/controllers/EditController.js
@@ -22,7 +22,8 @@
 /*global define,Promise*/
 
 /**
- * Module defining EditController. Created by vwoeltje on 11/14/14.
+ * This bundle implements Edit mode.
+ * @namespace platform/commonUI/edit
  */
 define(
     ["../objects/EditableDomainObject"],
diff --git a/platform/commonUI/general/src/StyleSheetLoader.js b/platform/commonUI/general/src/StyleSheetLoader.js
index fe535df888..19c0ffc291 100644
--- a/platform/commonUI/general/src/StyleSheetLoader.js
+++ b/platform/commonUI/general/src/StyleSheetLoader.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle provides various general-purpose UI elements, including
+ * platform styling.
+ * @namespace platform/commonUI/general
+ */
 define(
     [],
     function () {
diff --git a/platform/commonUI/inspect/src/InfoConstants.js b/platform/commonUI/inspect/src/InfoConstants.js
index c5886cba92..4927de870f 100644
--- a/platform/commonUI/inspect/src/InfoConstants.js
+++ b/platform/commonUI/inspect/src/InfoConstants.js
@@ -20,6 +20,13 @@
  * at runtime from the About dialog for additional information.
  *****************************************************************************/
 /*global define*/
+
+/**
+ * This bundle provides support for object inspection (specifically, metadata
+ * show in bubbles on hover.)
+ * @namespace platform/commonUI/inspect
+ */
+
 define({
     BUBBLE_TEMPLATE: "<mct-container key=\"bubble\" " +
                 "bubble-title=\"{{bubbleTitle}}\" " +
diff --git a/platform/containment/src/CompositionPolicy.js b/platform/containment/src/CompositionPolicy.js
index 2fcd4e94a9..9445803557 100644
--- a/platform/containment/src/CompositionPolicy.js
+++ b/platform/containment/src/CompositionPolicy.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements "containment" rules, which determine which objects
+ * can be contained within which other objects.
+ * @namespace platform/containment
+ */
 define(
     ['./ContainmentTable'],
     function (ContainmentTable) {
diff --git a/platform/core/src/objects/DomainObjectProvider.js b/platform/core/src/objects/DomainObjectProvider.js
index 852afd2847..732da80518 100644
--- a/platform/core/src/objects/DomainObjectProvider.js
+++ b/platform/core/src/objects/DomainObjectProvider.js
@@ -22,7 +22,9 @@
 /*global define,Promise*/
 
 /**
- * Module defining DomainObjectProvider. Created by vwoeltje on 11/7/14.
+ * This bundle implements core components of Open MCT Web's service
+ * infrastructure and information model.
+ * @namespace platform/core
  */
 define(
     ["./DomainObject"],
diff --git a/platform/entanglement/src/services/LocationService.js b/platform/entanglement/src/services/LocationService.js
index e4b54183b6..cb0a632b4e 100644
--- a/platform/entanglement/src/services/LocationService.js
+++ b/platform/entanglement/src/services/LocationService.js
@@ -22,6 +22,11 @@
 
 /*global define */
 
+/**
+ * This bundle implements actions which control the location of objects
+ * (move, copy, link.)
+ * @namespace platform/entanglement
+ */
 define(
     function () {
         "use strict";
diff --git a/platform/execution/src/WorkerService.js b/platform/execution/src/WorkerService.js
index 616c268e60..a428947a5c 100644
--- a/platform/execution/src/WorkerService.js
+++ b/platform/execution/src/WorkerService.js
@@ -21,6 +21,12 @@
  *****************************************************************************/
 /*global define*/
 
+
+/**
+ * This bundle contains services for managing the flow of execution,
+ * such as support for running web workers on background threads.
+ * @namespace platform/execution
+ */
 define(
     [],
     function () {
diff --git a/platform/features/events/src/EventListController.js b/platform/features/events/src/EventListController.js
index c67e938776..c2247dde8c 100644
--- a/platform/features/events/src/EventListController.js
+++ b/platform/features/events/src/EventListController.js
@@ -21,11 +21,16 @@
  *****************************************************************************/
 /*global define*/
 
-/**
+/*
  * Module defining EventListController. 
  * Created by chacskaylo on 06/18/2015. 
  * Modified by shale on 06/23/2015.
  */
+
+/**
+ * This bundle implements the "Events" view of string telemetry.
+ * @namespace platform/features/events
+ */
 define(
     ["./DomainColumn", "./RangeColumn", "./EventListPopulator"],
     function (DomainColumn, RangeColumn, EventListPopulator) {
diff --git a/platform/features/imagery/src/controllers/ImageryController.js b/platform/features/imagery/src/controllers/ImageryController.js
index e3d1e3db2b..30513e7e6b 100644
--- a/platform/features/imagery/src/controllers/ImageryController.js
+++ b/platform/features/imagery/src/controllers/ImageryController.js
@@ -21,6 +21,10 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements views of image telemetry.
+ * @namespace platform/features/imagery
+ */
 define(
     ['moment'],
     function (moment) {
diff --git a/platform/features/layout/src/LayoutController.js b/platform/features/layout/src/LayoutController.js
index 359646b5b7..bf7c265de0 100644
--- a/platform/features/layout/src/LayoutController.js
+++ b/platform/features/layout/src/LayoutController.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements object types and associated views for
+ * display-building.
+ * @namespace platform/features/layout
+ */
 define(
     ['./LayoutDrag'],
     function (LayoutDrag) {
diff --git a/platform/features/pages/src/EmbeddedPageController.js b/platform/features/pages/src/EmbeddedPageController.js
index 843492866f..f7720bc62c 100644
--- a/platform/features/pages/src/EmbeddedPageController.js
+++ b/platform/features/pages/src/EmbeddedPageController.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle adds the Web Page object type, which can be used to embed
+ * other web pages with layouts.
+ * @namespace platform/features/pages
+ */
 define(
     [],
     function () {
diff --git a/platform/features/plot/src/PlotController.js b/platform/features/plot/src/PlotController.js
index 3c944f362b..da8dcfb168 100644
--- a/platform/features/plot/src/PlotController.js
+++ b/platform/features/plot/src/PlotController.js
@@ -22,7 +22,8 @@
 /*global define*/
 
 /**
- * Module defining PlotController. Created by vwoeltje on 11/12/14.
+ * This bundle adds a "Plot" view for numeric telemetry data.
+ * @namespace platform/features/plot
  */
 define(
     [
diff --git a/platform/features/scrolling/src/ScrollingListController.js b/platform/features/scrolling/src/ScrollingListController.js
index 522a762474..0a179f6102 100644
--- a/platform/features/scrolling/src/ScrollingListController.js
+++ b/platform/features/scrolling/src/ScrollingListController.js
@@ -22,7 +22,8 @@
 /*global define,Promise*/
 
 /**
- * Module defining ListController. Created by vwoeltje on 11/18/14.
+ * This bundle implements a "Scrolling List" view of telemetry data.
+ * @namespace platform/features/scrolling
  */
 define(
     ["./NameColumn", "./DomainColumn", "./RangeColumn", "./ScrollingListPopulator"],
diff --git a/platform/forms/src/MCTForm.js b/platform/forms/src/MCTForm.js
index fb288ed244..0629fbfd21 100644
--- a/platform/forms/src/MCTForm.js
+++ b/platform/forms/src/MCTForm.js
@@ -22,7 +22,9 @@
 /*global define,Promise*/
 
 /**
- * Module defining MCTForm. Created by vwoeltje on 11/10/14.
+ * This bundle implements directives for displaying and handling forms for
+ * user input.
+ * @namespace platform/forms
  */
 define(
     ["./controllers/FormController"],
diff --git a/platform/framework/src/Main.js b/platform/framework/src/Main.js
index 47391a6bb5..cf8f270336 100644
--- a/platform/framework/src/Main.js
+++ b/platform/framework/src/Main.js
@@ -32,6 +32,11 @@ requirejs.config({
     }
 });
 
+/**
+ * Implements the framework layer, which handles the loading of bundles
+ * and the wiring-together of the extensions they expose.
+ * @namespace platform/framework
+ */
 define(
     [
         'require',
diff --git a/platform/persistence/cache/src/CachingPersistenceDecorator.js b/platform/persistence/cache/src/CachingPersistenceDecorator.js
index a4ff16c09e..5d9676cfe7 100644
--- a/platform/persistence/cache/src/CachingPersistenceDecorator.js
+++ b/platform/persistence/cache/src/CachingPersistenceDecorator.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle decorates the persistence service to maintain a local cache
+ * of persisted documents.
+ * @namespace platform/persistence/cache
+ */
 define(
     [],
     function () {
diff --git a/platform/persistence/couch/src/CouchPersistenceProvider.js b/platform/persistence/couch/src/CouchPersistenceProvider.js
index 77c8ac7bd8..1269780b35 100644
--- a/platform/persistence/couch/src/CouchPersistenceProvider.js
+++ b/platform/persistence/couch/src/CouchPersistenceProvider.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements a persistence service which uses CouchDB to
+ * store documents.
+ * @namespace platform/persistence/cache
+ */
 define(
     ["./CouchDocument"],
     function (CouchDocument) {
diff --git a/platform/persistence/elastic/src/ElasticPersistenceProvider.js b/platform/persistence/elastic/src/ElasticPersistenceProvider.js
index dffd13044e..2cc864ded2 100644
--- a/platform/persistence/elastic/src/ElasticPersistenceProvider.js
+++ b/platform/persistence/elastic/src/ElasticPersistenceProvider.js
@@ -21,6 +21,11 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements a persistence service which uses ElasticSearch to
+ * store documents.
+ * @namespace platform/persistence/elastic
+ */
 define(
     [],
     function () {
diff --git a/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js b/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js
index b60d316407..fddaebfead 100644
--- a/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js
+++ b/platform/persistence/queue/src/QueuingPersistenceCapabilityDecorator.js
@@ -22,7 +22,10 @@
 /*global define,Promise*/
 
 /**
- * Module defining CoreCapabilityProvider. Created by vwoeltje on 11/7/14.
+ * This bundle decorates the persistence service to handle persistence
+ * in batches, and to provide notification of persistence errors in batches
+ * as well.
+ * @namespace platform/persistence/queue
  */
 define(
     ['./QueuingPersistenceCapability'],
diff --git a/platform/policy/src/PolicyProvider.js b/platform/policy/src/PolicyProvider.js
index 228b4c47ef..9c63d154f2 100644
--- a/platform/policy/src/PolicyProvider.js
+++ b/platform/policy/src/PolicyProvider.js
@@ -21,6 +21,10 @@
  *****************************************************************************/
 /*global define*/
 
+/**
+ * This bundle implements the policy service.
+ * @namespace platform/policy
+ */
 define(
     [],
     function () {
diff --git a/platform/representation/src/MCTRepresentation.js b/platform/representation/src/MCTRepresentation.js
index 1fba543d22..8a02fa07e7 100644
--- a/platform/representation/src/MCTRepresentation.js
+++ b/platform/representation/src/MCTRepresentation.js
@@ -22,7 +22,9 @@
 /*global define,Promise*/
 
 /**
- * Module defining MCTRepresentation. Created by vwoeltje on 11/7/14.
+ * This bundle implements the directives for representing domain objects
+ * as Angular-managed HTML.
+ * @namespace platform/representation
  */
 define(
     [],
diff --git a/platform/representation/src/gestures/GestureConstants.js b/platform/representation/src/gestures/GestureConstants.js
index d41fd1b89b..f43487424a 100644
--- a/platform/representation/src/gestures/GestureConstants.js
+++ b/platform/representation/src/gestures/GestureConstants.js
@@ -30,7 +30,6 @@ 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.GestureConstants
      */
     MCT_DRAG_TYPE: 'mct-domain-object-id',
diff --git a/platform/telemetry/src/TelemetryAggregator.js b/platform/telemetry/src/TelemetryAggregator.js
index 8a30e4bc2f..d824518207 100644
--- a/platform/telemetry/src/TelemetryAggregator.js
+++ b/platform/telemetry/src/TelemetryAggregator.js
@@ -22,7 +22,9 @@
 /*global define*/
 
 /**
- * Module defining TelemetryProvider. Created by vwoeltje on 11/12/14.
+ * This bundle provides infrastructure and utility services for handling
+ * telemetry data.
+ * @namespace platform/telemetry
  */
 define(
     [],